mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-09 14:34:43 +00:00
d933b1b48b
Adds docs for the REST API, translate API, the CLI, and JDBC. Next we need to add more example queries and documentation for our extensions. Original commit: elastic/x-pack-elasticsearch@ed6d1360d2
49 lines
1.2 KiB
Plaintext
49 lines
1.2 KiB
Plaintext
[role="xpack"]
|
|
[[sql-translate]]
|
|
== SQL Translate API
|
|
|
|
The SQL Translate API accepts SQL in a JSON document and translates it
|
|
into native Elasticsearch queries. For example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /_sql/translate
|
|
{
|
|
"query": "SELECT * FROM library ORDER BY page_count DESC",
|
|
"fetch_size": 10
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:library]
|
|
|
|
Which returns:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"size" : 10,
|
|
"docvalue_fields" : [
|
|
"author",
|
|
"name",
|
|
"page_count",
|
|
"release_date"
|
|
],
|
|
"sort" : [
|
|
{
|
|
"page_count" : {
|
|
"order" : "desc"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE
|
|
|
|
Which is the request that SQL will run to provide the results.
|
|
In this case, SQL will use the <<search-request-scroll,scroll>>
|
|
API. If the result contained an aggregation then SQL would use
|
|
the normal <<search-request-body,search>> API.
|
|
|
|
The request body accepts all of the <<sql-rest-fields,fields>> that
|
|
the <<sql-rest,SQL REST API>> accepts except `cursor`.
|