The Open Distro for Elasticsearch SQL Workbench enables you to query your Elasticsearch data using SQL syntax from a dedicated Kibana UI. You can download your query results data in JSON, JDBC, CSV and raw text formats.
Please see our technical documentation to learn more about its features.
-
Download Elasticsearch for the version that matches the Kibana version specified in package.json.
-
Download and install the most recent version of Open Distro for Elasticsearch SQL plugin.
-
Download the Kibana source code for the version specified in package.json you want to set up.
See the Kibana contributing guide for more instructions on setting up your development environment.
-
Change your node version to the version specified in
.node-versioninside the Kibana root directory. -
cd into the Kibana source code directory.
-
Check out this package from version control into the
pluginsdirectory.
git clone git@github.com: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
- Run
yarn kbn bootstrapinsidekibana/plugins/sql-workbench.
Ultimately, your directory structure should look like this:
.
├── kibana
│ └── plugins
│ └── sql-workbenchTo build the plugin's distributable zip simply run yarn build.
Example output: ./build/opendistro-sql-workbench-*.zip
-
yarn startStarts Kibana and includes this plugin. Kibana will be available on
localhost:5601. -
NODE_PATH=../../node_modules yarn test:jestRuns the plugin tests.
- Refer to CONTRIBUTING.md.
- Since this is a workbench, it can be useful to review the Kibana contributing guide alongside the documentation around workbenchs and plugin development.
Please file an issue to report any bugs you may find, enhancements you may need or questions you may have here.
This code is licensed under the Apache 2.0 License.
Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.