This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
SQL Translate API
editSQL Translate API
editThe SQL Translate API accepts SQL in a JSON document and translates it into native Elasticsearch queries. For example:
resp = client.sql.translate(
query="SELECT * FROM library ORDER BY page_count DESC",
fetch_size=10,
)
print(resp)
response = client.sql.translate(
body: {
query: 'SELECT * FROM library ORDER BY page_count DESC',
fetch_size: 10
}
)
puts response
const response = await client.sql.translate({
query: "SELECT * FROM library ORDER BY page_count DESC",
fetch_size: 10,
});
console.log(response);
POST /_sql/translate
{
"query": "SELECT * FROM library ORDER BY page_count DESC",
"fetch_size": 10
}
Which returns:
{
"size": 10,
"_source": false,
"fields": [
{
"field": "author"
},
{
"field": "name"
},
{
"field": "page_count"
},
{
"field": "release_date",
"format": "strict_date_optional_time_nanos"
}
],
"sort": [
{
"page_count": {
"order": "desc",
"missing": "_first",
"unmapped_type": "short"
}
}
],
"track_total_hits": -1
}
Which is the request that SQL will run to provide the results. In this case, SQL will use the scroll API. If the result contained an aggregation then SQL would use the normal search API.
The request body accepts the same parameters as
the SQL search API, excluding cursor.