Translate SQL into Elasticsearch queries Generally available; Added in 6.3.0

GET /_sql/translate
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

POST /_sql/translate

GET /_sql/translate

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.

highlight#highlightFromAnchor" href="#topic-required-authorization"> Required authorization

  • Index privileges: read
application/json

Body Required

  • fetch_size number

    The maximum number of rows (or entries) to return in one response.

    Default value is 1000.

  • 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

Responses

GET /_sql/translate
dropdown#toggle click@window->dropdown#hide touchend@window->dropdown#hide" data-dropdown-target="button" data-scrollable="false" data-headings="false" aria-expanded="false" aria-haspopup="true" role="menu" tabindex="0">
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"
client.sql().translate(t -> t
    .fetchSize(10)
    .query("SELECT * FROM library ORDER BY page_count DESC")
);
Request example 
{
  "query": "SELECT * FROM library ORDER BY page_count DESC",
  "fetch_size": 10
}