[[reference-sql-translate]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.sql.translate

Translates SQL into Elasticsearch queries

{ref}/sql-translate-api.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(SqlTranslateRequest, options?): Promise<SqlTranslateResponse>
----

[discrete]
===== `SqlTranslateRequest`

[source,ts]
----
interface SqlTranslateRequest extends <<shared-type-request-base, RequestBase>> {
  fetch_size?: <<shared-type-integer, integer>>
  filter?: QueryDslQueryContainer
  query: string
  time_zone?: <<shared-type-time-zone, TimeZone>>
}
----

[discrete]
===== `SqlTranslateResponse`

[source,ts]
----
interface SqlTranslateResponse {
  aggregations?: Record<string, AggregationsAggregationContainer>
  size?: <<shared-type-long, long>>
  _source?: SearchSourceConfig
  fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
  query?: QueryDslQueryContainer
  sort?: <<shared-type-sort, Sort>>
}
----

