Translate SQL into Elasticsearch queries Added in 6.3.0

GET /_sql/translate
Api key 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.

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:
      _types:SourceConfig boolean _types: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.

      Additional properties are allowed.

      External documentation

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

      One of:
      _types:Field string _types:SortOptions object _types: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:
      _types:Field string _types:SortOptions object

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
GET /_sql/translate 
curl \
 --request GET http://api.example.com/_sql/translate \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"fetch_size":42.0,"filter":{},"query":"string","time_zone":"string"}'