Translate SQL into Elasticsearch queries Generally available; Added in 6.3.0

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

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
application/json

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

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • aggregations object
    • size number

    • _source boolean | object

      Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

      One of:
      boolean-1 boolean SourceFilter object
    • fields array[object]

      A reference to a field with formatting instructions on how to return the value

      Hide fields attributes Show fields attributes object
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • format string

        The format in which the values are returned.

      • include_unmapped boolean
    • query object

      An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      External documentation

    • sort string | object | array[string | object]

      One of:
      Field string SortOptions object array-2 array[string | object]

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      One of:
      Field string SortOptions object

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
GET /_sql/translate 
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 }