Translate SQL into Elasticsearch queries Generally available; Added in 6.3.0

POST /_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

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:
      SourceConfig boolean SourceFilter object
    • fields array[object]
      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 Sort 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.
POST /_sql/translate 
POST _sql/translate
{
  "query": "SELECT * FROM library ORDER BY page_count DESC",
  "fetch_size": 10
}
curl \
 --request POST 'http://api.example.com/_sql/translate' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n  \"fetch_size\": 10\n}"'
Request example 
{
  "query": "SELECT * FROM library ORDER BY page_count DESC",
  "fetch_size": 10
}