Skip to content

Commit

Permalink
Refactor readme (#148)
Browse files Browse the repository at this point in the history 
Signed-off-by: Chen Dai <daichen@amazon.com>
  • Loading branch information
@dai-chen
dai-chen authored Jun 30, 2021
1 parent 254510e commit 5a6a3e8
Showing 1 changed file with 22 additions and 171 deletions.
193 changes: 22 additions & 171 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@
[![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/sql/)
![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)

# OpenSearch SQL
<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>

- [OpenSearch SQL](#opensearch-sql)
- [Highlights](#highlights)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Attribution](#attribution)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)

OpenSearch enables you to extract insights out of OpenSearch 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.

# OpenSearch SQL

## SQL Related Projects
OpenSearch enables you to extract insights out of OpenSearch using the familiar SQL or Piped Processing Language (PPL) 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.

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 OpenSearch.

Expand All @@ -21,197 +30,39 @@ The following projects have been merged into this repository as separate folders
* [Query Workbench](https://github.com/opensearch-project/sql/tree/main/workbench)


## Documentation

Please refer to the [SQL Language Reference Manual](./docs/user/index.rst), [Piped Processing Language (PPL) Reference Manual](./docs/user/ppl/index.rst) and [Technical Documentation](https://docs-beta.opensearch.org/) for detailed information on installing and configuring plugin. Looking to contribute? Read the instructions on [Developer Guide](./DEVELOPER_GUIDE.rst) and then submit a patch!

## SQL Engine V2

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 the new released Piped Processing Language. However, it was experimental and disabled by default for SQL query processing. With most important features and full testing complete, now we're ready to promote it as our default SQL query engine. Please find more details in [SQL Engine V2 - Release Notes](/docs/dev/NewSQLEngine.md).


## Setup

Install as plugin: build plugin from source code by following the instruction in Build section and install it to your OpenSearch.

After doing this, you need to restart the OpenSearch server. Otherwise you may get errors like `Invalid index name [sql], must not start with '']; ","status":400}`.


## Build

The package uses the [Gradle](https://docs.gradle.org/4.10.2/userguide/userguide.html) build system.

1. Checkout this package from version control.
2. To build from command line set `JAVA_HOME` to point to a JDK >=14
3. Run `./gradlew build`


## Basic Usage

To use the feature, send requests to the `_plugins/_sql` URI. You can use a request parameter or the request body (recommended). Note that for backward compatibility, old `_opendistro/_sql` endpoint is still available, though any future API will be only accessible by new OpenSearch endpoint.

* Simple query

```
POST https://<host>:<port>/_plugins/_sql
{
"query": "SELECT * FROM my-index LIMIT 50"
}
```

* Explain SQL to OpenSearch query DSL
```
POST _plugins/_sql/_explain
{
"query": "SELECT * FROM my-index LIMIT 50"
}
```

* For a sample curl command with the OpenSearch Security plugin, try:
```
curl -XPOST https://localhost:9200/_plugins/_sql -u admin:admin -k -d '{"query": "SELECT * FROM my-index LIMIT 10"}' -H 'Content-Type: application/json'
```


## SQL Usage

* Query

SELECT * FROM bank WHERE age >30 AND gender = 'm'
## Highlights

* Aggregation
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.

SELECT COUNT(*),SUM(age),MIN(age) as m, MAX(age),AVG(age)
FROM bank
GROUP BY gender
HAVING m >= 20
ORDER BY SUM(age), m DESC
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/NewSQLEngine.md).

* Join

SELECT b1.firstname, b1.lastname, b2.age
FROM bank b1
LEFT JOIN bank b2
ON b1.age = b2.age AND b1.state = b2.state

* Show

SHOW TABLES LIKE ban%
DESCRIBE TABLES LIKE bank

* Delete

DELETE FROM bank WHERE age >30 AND gender = 'm'


## Beyond SQL

* Search

SELECT address FROM bank WHERE address = matchQuery('880 Holmes Lane') ORDER BY _score DESC LIMIT 3

* Nested Field

+
SELECT address FROM bank b, b.nestedField e WHERE b.state = 'WA' and e.name = 'test'
+
SELECT address, nested(nestedField.name)
FROM bank
WHERE nested(nestedField, nestedField.state = 'WA' AND nestedField.name = 'test')
OR nested(nestedField.state) = 'CA'

* Aggregations

+ range age group 20-25,25-30,30-35,35-40

SELECT COUNT(age) FROM bank GROUP BY range(age, 20,25,30,35,40)

+ range date group by day

SELECT online FROM online GROUP BY date_histogram(field='insert_time','interval'='1d')

+ range date group by your config

SELECT online FROM online GROUP BY date_range(field='insert_time','format'='yyyy-MM-dd' ,'2014-08-18','2014-08-17','now-8d','now-7d','now-6d','now')

* OpenSearch Geographic

SELECT * FROM locations WHERE GEO_BOUNDING_BOX(fieldname,100.0,1.0,101,0.0)

* Select type or pattern

SELECT * FROM indexName/type
SELECT * FROM index*


## SQL Features
## Documentation

* SQL Select
* SQL Delete
* SQL Where
* SQL Order By
* SQL Group By
* SQL Having
* SQL Inner Join
* SQL Left Join
* SQL Show
* SQL Describe
* SQL AND & OR
* SQL Like
* SQL COUNT distinct
* SQL In
* SQL Between
* SQL Aliases
* SQL Not Null
* SQL(OpenSearch) Date
* SQL avg()
* SQL count()
* SQL max()
* SQL min()
* SQL sum()
* SQL Nulls
* SQL isnull()
* SQL floor
* SQL trim
* SQL log
* SQL log10
* SQL substring
* SQL round
* SQL sqrt
* SQL concat_ws
* SQL union and minus
Please refer to the [SQL Language Reference Manual](./docs/user/index.rst), [Piped Processing Language (PPL) Reference Manual](./docs/user/ppl/index.rst) and [Technical Documentation](https://docs-beta.opensearch.org/) for detailed information on installing and configuring plugin.

## JDBC Support

Please check out JDBC driver repository for more details.
## Contributing

## Beyond SQL features
See [developer guide](DEVELOPER_GUIDE.rst) and [how to contribute to this project](CONTRIBUTING.md).

* OpenSearch TopHits
* OpenSearch MISSING
* OpenSearch STATS
* OpenSearch GEO_INTERSECTS
* OpenSearch GEO_BOUNDING_BOX
* OpenSearch GEO_DISTANCE
* OpenSearch GEOHASH_GRID aggregation

## Attribution

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).


## Code of Conduct

This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md).


## Security issue notifications
## Security

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.


## Licensing
## License

See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Expand Down

0 comments on commit 5a6a3e8

Please sign in to comment.