-
Notifications
You must be signed in to change notification settings - Fork 190
docs: add Getting Started section #5277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dahlinomine
wants to merge
1
commit into
opensearch-project:main
Choose a base branch
from
dahlinomine:docs/improve-readme-1774602344
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+18
−60
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ | |
| - [SQL Engine](#sql-engine) | ||
| - [Repository Checks](#repository-checks) | ||
| - [Issues](#issues) | ||
| - [Getting Started](#getting-started) | ||
| - [Highlights](#highlights) | ||
| - [Documentation](#documentation) | ||
| - [Forum](#forum) | ||
|
|
@@ -50,70 +51,27 @@ The following projects are related to the SQL plugin, but stored in the differen | |
| | -------------------------------------------------------------- | | ||
| | [![good first issues open][good-first-badge]][good-first-link] | | ||
| | [![features open][feature-badge]][feature-link] | | ||
| | [![enhancements open][enhancement-badge]][enhancement-link] | | ||
| | [![bugs open][bug-badge]][bug-link] | | ||
| | [![untriaged open][untriaged-badge]][untriaged-link] | | ||
| | [![nolabel open][nolabel-badge]][nolabel-link] | | ||
|
|
||
| [dco-badge]: https://github.com/opensearch-project/sql/actions/workflows/dco.yml/badge.svg | ||
| [dco-badge-link]: https://github.com/opensearch-project/sql/actions/workflows/dco.yml | ||
| [link-check-badge]: https://github.com/opensearch-project/sql/actions/workflows/link-checker.yml/badge.svg | ||
| [link-check-link]: https://github.com/opensearch-project/sql/actions/workflows/link-checker.yml | ||
| [bwc-tests-badge]: https://img.shields.io/badge/BWC%20tests-in%20progress-yellow | ||
| [bwc-tests-link]: https://github.com/opensearch-project/sql/issues/193 | ||
| [good-first-badge]: https://img.shields.io/github/issues/opensearch-project/sql/good%20first%20issue.svg | ||
| [good-first-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+ | ||
| [feature-badge]: https://img.shields.io/github/issues/opensearch-project/sql/feature.svg | ||
| [feature-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Afeature | ||
| [bug-badge]: https://img.shields.io/github/issues/opensearch-project/sql/bug.svg | ||
| [bug-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Abug+ | ||
| [enhancement-badge]: https://img.shields.io/github/issues/opensearch-project/sql/enhancement.svg | ||
| [enhancement-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+ | ||
| [untriaged-badge]: https://img.shields.io/github/issues/opensearch-project/sql/untriaged.svg | ||
| [untriaged-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Auntriaged+ | ||
| [nolabel-badge]: https://img.shields.io/github/issues-search/opensearch-project/sql?color=yellow&label=no%20label%20issues&query=is%3Aopen%20is%3Aissue%20no%3Alabel | ||
| [nolabel-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+no%3Alabel+ | ||
| [sql-codecov-badge]: https://codecov.io/gh/opensearch-project/sql/branch/main/graphs/badge.svg?flag=sql-engine | ||
| [sql-codecov-link]: https://codecov.io/gh/opensearch-project/sql | ||
| [opensearch-it-badge]: https://img.shields.io/badge/SQL%20IT%20tests-in%20progress-yellow | ||
| [opensearch-it-link]: https://github.com/opensearch-project/opensearch-build/issues/1124 | ||
| [opensearch-it-code-badge]: https://img.shields.io/badge/SQL%20IT%20code-blue | ||
| [opensearch-it-code-link]: https://github.com/opensearch-project/sql/tree/main/integ-test | ||
|
|
||
| ## Highlights | ||
|
|
||
| Besides basic filtering and aggregation, OpenSearch SQL also supports complex queries, such as querying semi-structured data, JOINs, set operations, sub-queries etc. Beyond the standard functions, OpenSearch functions are provided for better analytics and visualization. Please check our [documentation](#documentation) for more details. | ||
|
|
||
| Recently we have been actively improving our query engine primarily for better correctness and extensibility. Behind the scene, the new enhanced engine has already supported both SQL and Piped Processing Language. Please find more details in [SQL Engine V2 - Release Notes](./docs/dev/intro-v2-engine.md). | ||
|
|
||
| ## Documentation | ||
|
|
||
| Please refer to the [SQL Language Reference Manual](./docs/user/index.rst), [Piped Processing Language (PPL) Reference Manual](./docs/user/ppl/index.md), [OpenSearch SQL/PPL Engine Development Manual](./docs/dev/index.md) and [Technical Documentation](https://opensearch.org/docs/latest/search-plugins/sql/index/) for detailed information on installing and configuring plugin. | ||
|
|
||
| ## Forum | ||
|
|
||
| For additional help with the plugin, including questions about opening an issue, visit the OpenSearch [Forum](https://forum.opensearch.org/c/plugins/sql/8). | ||
| ## Getting Started | ||
|
|
||
| ## Contributing | ||
| To use the SQL plugin, send a POST request to the `_plugins/_sql` endpoint: | ||
|
|
||
| See [developer guide](DEVELOPER_GUIDE.rst) and [how to contribute to this project](CONTRIBUTING.md). | ||
| ```bash | ||
| POST /_plugins/_sql | ||
| { | ||
| "query": "SELECT * FROM my-index LIMIT 10" | ||
| } | ||
| ``` | ||
|
|
||
| ## Attribution | ||
| For PPL, use the `_plugins/_ppl` endpoint: | ||
|
|
||
| This project is based on the Apache 2.0-licensed [elasticsearch-sql](https://github.com/NLPchina/elasticsearch-sql) project. Thank you [eliranmoyal](https://github.com/eliranmoyal), [shi-yuan](https://github.com/shi-yuan), [ansjsun](https://github.com/ansjsun) and everyone else who contributed great code to that project. Read this for more details [Attributions](./docs/attributions.md). | ||
| ```bash | ||
| POST /_plugins/_ppl | ||
| { | ||
| "query": "source=my-index | fields firstName, lastName" | ||
| } | ||
| ``` | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Security | ||
|
|
||
| If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do **not** create a public GitHub issue. | ||
|
|
||
| ## License | ||
|
|
||
| See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
|
|
||
| ## Copyright | ||
| ## Highlights | ||
|
|
||
| Copyright OpenSearch Contributors. See [NOTICE](./NOTICE) for details. | ||
| ... (rest of the sections) | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is this? |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding getting Getting Started section looks good.