Translate SQL into Elasticsearch queries
Generally available; Added in 6.3.0
Translate an SQL search into a search API request containing Query DSL.
It accepts the same request body parameters as the SQL search API, excluding cursor
.
Required authorization
- Index privileges:
read
Body
Required
-
fetch_size
number The maximum number of rows (or entries) to return in one response.
-
filter
object An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
External documentation -
query
string Required The SQL query to run.
-
time_zone
string
POST
/_sql/translate
Console
POST _sql/translate
{
"query": "SELECT * FROM library ORDER BY page_count DESC",
"fetch_size": 10
}
resp = client.sql.translate(
query="SELECT * FROM library ORDER BY page_count DESC",
fetch_size=10,
)
const response = await client.sql.translate({
query: "SELECT * FROM library ORDER BY page_count DESC",
fetch_size: 10,
});
response = client.sql.translate(
body: {
"query": "SELECT * FROM library ORDER BY page_count DESC",
"fetch_size": 10
}
)
$resp = $client->sql()->translate([
"body" => [
"query" => "SELECT * FROM library ORDER BY page_count DESC",
"fetch_size" => 10,
],
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"query":"SELECT * FROM library ORDER BY page_count DESC","fetch_size":10}' "$ELASTICSEARCH_URL/_sql/translate"
Request example
{
"query": "SELECT * FROM library ORDER BY page_count DESC",
"fetch_size": 10
}