Update docs after merging repos

README.md

@@ -8,6 +8,17 @@
 
 Open Distro for Elasticsearch enables you to extract insights out of Elasticsearch using the familiar SQL query syntax. Use aggregations, group by, and where clauses to investigate your data. Read your data as JSON documents or CSV tables so you have the flexibility to use the format that works best for you.
 
+
+## SQL Related Projects
+
+The following projects have been merged into this repository as separate folders as of July 9, 2020. Please refer to links below for details. This document will focus on the SQL plugin for Elasticsearch.
+
+* [SQL CLI](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-cli)
+* [SQL JDBC](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-jdbc)
+* [SQL ODBC](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc)
+* [SQL Workbench](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-workbench)
+
+
 ## Documentation
 
 Please refer to the [reference manual](./docs/user/index.rst) and [technical documentation](https://opendistro.github.io/for-elasticsearch-docs) for detailed information on installing and configuring opendistro-elasticsearch-sql plugin. Looking to contribute? Read the instructions on [Development Guide](./docs/developing.rst) and then submit a patch!

docs/attributions.md

@@ -22,7 +22,7 @@ Apart from the problems we identified earlier, we made significant improvement i
 
 1. *Integration Test*: We migrated all integrate tests to standard Elasticsearch IT framework which spins up in-memory cluster for testing. Now all test cases treat plugin code as blackbox and verify functionality from externally.
 2. *New JDBC Driver*: We developed our own JDBC driver without any dependency on Elasticsearch proprietary code.
-    [sql-jdbc](https://github.com/opendistro-for-elasticsearch/sql-jdbc)
+    [sql-jdbc](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-jdbc)
 3. *Better Hash JOIN*: OpenDistro SQL launched with Block Hash Join implementation with circuit break mechanism to protect your Elasticsearch memory. Performance testing showed our implementation is 1.5 ~ 2x better than old hash join in terms of throughput and latency and much lower error rate under heavy pressure.
 4. *Query Planner*: Logical and physical planner was added to support JOIN query in efficient and extendible way.
 5. *PartiQL Compatibility*: we are partially compatible with PartiQL specification which allows for query involved in nested JSON documents.

docs/dev/Doctest.md

@@ -145,7 +145,7 @@ Doctest is relying on the console/command line to run code examples in documenta
     * https://github.com/crate/crate/blob/master/docs/general/dql/selects.rst
 
 
-Similar to CarateDB using it’s CLI “crash”, we can make use of our own [SQL-CLI](https://github.com/opendistro-for-elasticsearch/sql-cli)
+Similar to CrateDB using it’s CLI “crash”, we can make use of our own [SQL-CLI](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-cli)
 
 To support PPL, we need to add PPL support to SQL-CLI. Since PPL and SQL expose similar http endpoint for query and share similar response format. The update won’t be much of work.
 
@@ -270,4 +270,4 @@ FAILURE: Build failed with an exception.
 ### 2.3.2 generate report
 
 * Python tests can’t be integrated to Jacoco test reporting
-* TODO: need to figure out a better solution
+* TODO: need to figure out a better solution

sql-cli/CONTRIBUTING.md

@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql-cli/issues), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql-cli/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aopen+is%3Aissue+label%3ACLI), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aissue+is%3Aclosed+label%3ACLI), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
@@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/opendistro-for-elasticsearch/sql-cli/labels/help%20wanted) issues is a great place to start.
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3ACLI) issues is a great place to start.
 
 
 ## Code of Conduct
@@ -56,6 +56,6 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## Licensing
 
-See the [LICENSE](https://github.com/opendistro-for-elasticsearch/sql-cli/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-cli/LICENSE.TXT) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
 
 We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

sql-cli/README.md

@@ -1,4 +1,4 @@
-[![Test and Build Workflow](https://github.com/opendistro-for-elasticsearch/sql-cli/workflows/Test%20and%20Build/badge.svg)](https://github.com/opendistro-for-elasticsearch/sql-cli/actions)
+[![SQL CLI Test and Build](https://github.com/opendistro-for-elasticsearch/sql/workflows/SQL%20CLI%20Test%20and%20Build/badge.svg)](https://github.com/opendistro-for-elasticsearch/sql/actions)
 [![Latest Version](https://img.shields.io/pypi/v/odfe-sql-cli.svg)](https://pypi.python.org/pypi/odfe-sql-cli/)
 [![Documentation](https://img.shields.io/badge/documentation-blue.svg)](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/cli/)
 [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/sql/)
@@ -80,13 +80,13 @@ You can also configure the following connection properties:
     * Elasticsearch with X-pack security enabled
 * `--aws-auth`: Turns on AWS sigV4 authentication to connect to an Amazon Elasticsearch Service endpoint. Use with the AWS CLI (`aws configure`) to retrieve the local AWS configuration to authenticate and connect.
 
-For a list of all available configurations, see [clirc](https://github.com/opendistro-for-elasticsearch/sql-cli/blob/master/src/conf/clirc).
+For a list of all available configurations, see [clirc](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-cli/src/odfe_sql_cli/conf/clirc).
 
 
 
 ## Using the CLI
 
-1. Save the sample [accounts test data](https://github.com/opendistro-for-elasticsearch/sql/blob/master/src/test/resources/doctest/testdata/accounts.json) file.
+1. Save the sample [accounts test data](https://github.com/opendistro-for-elasticsearch/sql/blob/master/integ-test/src/test/resources/accounts.json) file.
 2. Index the sample data.
 
     ```
@@ -133,7 +133,7 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## Licensing
 
-See the [LICENSE](https://github.com/opendistro-for-elasticsearch/sql-cli/blob/master/LICENSE.TXT) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-cli/LICENSE.TXT) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
 
 
 

sql-jdbc/CONTRIBUTING.md

@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](../../issues), or [recently closed](../../issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](../../../issues?q=is%3Aopen+is%3Aissue+label%3AJDBC), or [recently closed](../../../issues?q=is%3Aissue+is%3Aclosed+label%3AJDBC), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
@@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](../../labels/help%20wanted) issues is a great place to start.
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](../../../issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3AJDBC) issues is a great place to start.
 
 
 ## Code of Conduct

sql-jdbc/docs/tableau.md

@@ -4,7 +4,7 @@
 
 * Download and install [Tableau Desktop](https://www.tableau.com/en-ca/products/desktop/download).
 * Install and configure [Open Distro for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/install/).
-* Download the [Open Distro for ElasticSearch JDBC Driver](https://github.com/opendistro-for-elasticsearch/sql-jdbc#download-and-installation).
+* Download the [Open Distro for ElasticSearch JDBC Driver](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-jdbc/README.md#download-and-installation).
 
 ## Setup
 
@@ -47,7 +47,7 @@ For futher details check [using a .tdc file with Tableau](https://kb.tableau.com
  ### Connection information
 
 You will need:
-* [JDBC connection string](https://github.com/opendistro-for-elasticsearch/sql-jdbc#connection-url-and-other-settings) to enter in the URL field when you connect.
+* [JDBC connection string](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-jdbc/README.md#connection-url-and-other-settings) to enter in the URL field when you connect.
 
   Sample connection string for connecting to localhost: `jdbc:elasticsearch://localhost:9200`.
 

sql-odbc/BUILD_INSTRUCTIONS.md

@@ -4,7 +4,7 @@ The ElasticsearchODBC driver can be build on Windows and Mac.
 
 ## Setting up Dependencies
 
-The driver [source code](https://github.com/opendistro-for-elasticsearch/sql-odbc) must be downloaded onto the system to build it.
+The driver [source code](https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc) must be downloaded onto the system to build it.
 
 ### Windows Dependencies
 

sql-odbc/CONTRIBUTING.md

@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/OpenDistro/elasticsearch-security-tlstool/issues), or [recently closed](https://github.com/OpenDistro/elasticsearch-security-tlstool/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aopen+is%3Aissue+label%3AODBC), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aissue+is%3Aclosed+label%3AODBC), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
@@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/OpenDistro/elasticsearch-security-tlstool/labels/help%20wanted) issues is a great place to start.
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3AODBC) issues is a great place to start.
 
 
 ## Code of Conduct
@@ -56,6 +56,6 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## Licensing
 
-See the [LICENSE](https://github.com/OpenDistro/elasticsearch-security-tlstool/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-odbc/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
 
 We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

sql-odbc/src/TableauConnector/odfe_sql_odbc/manifest.xml

@@ -3,8 +3,8 @@
 <connector-plugin class='odfe_sql_odbc' superclass='odbc' plugin-version='1.8.0.0' name='SQL' version='18.1' min-version-tableau='2020.1'>
   <vendor-information>
       <company name="Open Distro for ES"/>
-      <support-link url="https://github.com/opendistro-for-elasticsearch/sql-odbc"/>
-      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql-odbc"/>
+      <support-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
+      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
   </vendor-information>
   <connection-customization class="odfe_sql_odbc" enabled="true" version="10.0">
     <vendor name="Open Distro for ES"/>

sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/manifest.xml

@@ -3,8 +3,8 @@
 <connector-plugin class='odfe_sql_odbc_dev' superclass='odbc' plugin-version='0.2.0' name='Open Distro for Elasticsearch SQL ODBC DEV' version='18.1' min-version-tableau='2020.1'>
   <vendor-information>
       <company name="Open Distro for Elasticsearch"/>
-      <support-link url="https://github.com/opendistro-for-elasticsearch/sql-odbc"/>
-      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql-odbc"/>
+      <support-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
+      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
   </vendor-information>
   <connection-customization class="odfe_sql_odbc_dev" enabled="true" version="10.0">
     <vendor name="Open Distro for Elasticsearch"/>

sql-odbc/src/installer/Resources/README.txt

@@ -16,4 +16,4 @@ For example, if you want to use Tableau with Elasticsearch Server,
 4. Click on 'Connect'. All connection attributes will be retrived.
 5. Click on 'Sign In'. You will be successfully connected to elasticsearch server.
 
-For more details, check 'https://github.com/opendistro-for-elasticsearch/sql-odbc'.
+For more details, check 'https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc'.

sql-workbench/CONTRIBUTING.md

@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aissue+is%3Aclosed+label%3AWorkbench), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aissue+is%3Aclosed+label%3AWorkbench), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
@@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any issue tagged ["good first issue"](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3A%22good+first+issue%22) is a great place to start.
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any issue tagged ["good first issue"](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3A%22good+first+issue%22+label%3AWorkbench) is a great place to start.
 
 
 ## Code of Conduct

sql-workbench/README.md

@@ -17,9 +17,16 @@ Please see our technical [documentation](https://opendistro.github.io/for-elasti
    See the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#setting-up-your-development-environment) for more instructions on setting up your development environment.
 
 1. Change your node version to the version specified in `.node-version` inside the Kibana root directory.
-1. cd into `plugins` directory in the Kibana source code directory.
+1. cd into the Kibana source code directory.
 1. Check out this package from version control into the `plugins` directory.
-1. Run `yarn kbn bootstrap` inside `kibana/plugins/sql-workbench`.
+```
+git clone [email protected]:opendistro-for-elasticsearch/sql.git plugins --no-checkout
+cd plugins
+echo 'sql-workbench/*' >> .git/info/sparse-checkout
+git config core.sparseCheckout true
+git checkout master
+```
+6. Run `yarn kbn bootstrap` inside `kibana/plugins/sql-workbench`.
 
 Ultimately, your directory structure should look like this:
 
@@ -56,7 +63,7 @@ Example output: `./build/opendistro-sql-workbench-*.zip`
 
 ## Bugs, Enhancements or Questions
 
-Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues).
+Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opendistro-for-elasticsearch/sql/issues).
 
 ## License
 

sql-workbench/package.json

@@ -4,14 +4,14 @@
   "description": "SQL Workbench",
   "main": "index.js",
   "license": "Apache-2.0",
-  "homepage": "https://github.com/opendistro-for-elasticsearch/sql-workbench",
+  "homepage": "https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-workbench",
   "kibana": {
     "version": "7.8.0",
     "templateVersion": "6.3.3"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/opendistro-for-elasticsearch/sql-workbench"
+    "url": "https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-workbench"
   },
   "scripts": {
     "preinstall": "node ../../preinstall_check",