mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
ea635d67a6
Adds formal API docs for the following APIs: * Clear SQL cursor * SQL search * SQL translate Other changes: * Removes and redirects the "Supported REST parameters section." This is now covered in the SQL search API docs. * Updates a few related xrefs. Closes #75085
53 lines
1.2 KiB
Text
53 lines
1.2 KiB
Text
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[sql-translate-api]]
|
|
=== SQL translate API
|
|
++++
|
|
<titleabbrev>SQL translate</titleabbrev>
|
|
++++
|
|
|
|
Translates an <<sql-search-api,SQL search>> into a <<search-search,search API>>
|
|
request containing <<query-dsl,Query DSL>>. See <<sql-translate>>.
|
|
|
|
[source,console]
|
|
----
|
|
POST _sql/translate
|
|
{
|
|
"query": "SELECT * FROM library ORDER BY page_count DESC",
|
|
"fetch_size": 10
|
|
}
|
|
----
|
|
// TEST[setup:library]
|
|
|
|
[[sql-translate-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET _sql/translate`
|
|
|
|
`POST _sql/translate`
|
|
|
|
[[sql-translate-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `read`
|
|
<<privileges-list-indices,index privilege>> for the data stream, index,
|
|
or alias you search.
|
|
|
|
[[sql-translate-api-limitations]]
|
|
===== Limitations
|
|
|
|
See <<sql-limitations>>.
|
|
|
|
[role="child_attributes"]
|
|
[[sql-translate-api-request-body]]
|
|
==== {api-request-body-title}
|
|
|
|
The SQL translate API accepts the same request body parameters as the
|
|
<<sql-search-api-request-body,SQL search API>>, excluding `cursor`.
|
|
|
|
[role="child_attributes"]
|
|
[[sql-translate-api-response-body]]
|
|
==== {api-response-body-title}
|
|
|
|
The SQL translate API returns the same response body as the
|
|
<<search-search,search API>>.
|