Skip to content
This repository has been archived by the owner on Mar 31, 2021. It is now read-only.

added CONTRIBUTORS.md #34

Merged
merged 1 commit into from
May 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Contributors in order of last name:

Abbas Hussain

Zhongnan Su
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Open Distro for Elasticsearch SQL CLI

The SQL CLI component in Open Distro for Elasticsearch (ODFE) is a stand-alone Python application and can be launched by a 'wake' word `odfesql`. It serves as a support only for
[Open Distro SQL plugin for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/). User must have the ODFE SQL plugin installed to your Elasticsearch instance to connect. Users can run this CLI from MacOS and Linux, and connect to any valid Elasticsearch end-point such as Amazon Elasticsearch.
[Open Distro SQL plugin for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/). User must have the ODFE SQL plugin installed to your Elasticsearch instance to connect. Users can run this CLI from MacOS and Linux, and connect to any valid Elasticsearch end-point such as Amazon Elasticsearch.

## Installation
- `pip install odfesql`
Expand Down
5 changes: 3 additions & 2 deletions development_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@

### Run CLI
- Start an Elasticsearch instance from either local, Docker with Open Distro SQL plugin, or AWS Elasticsearch
- To launch the cli, use wake word `odfesql` followed by endpoint of your running ES instance. If not specifying
any endpoint, it uses http://localhost:9200 by default.
- To launch the cli, use 'wake' word `odfesql` followed by endpoint of your running ES instance. If not specifying
any endpoint, it uses http://localhost:9200 by default. If not provided with port number, http endpoint uses 9200 and
https uses 443 by default.

### Testing
- Prerequisites
Expand Down