71 lines
4.0 KiB
Plaintext
71 lines
4.0 KiB
Plaintext
[[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 <<RequestBase>> {
|
|
fetch_size?: <<integer>>
|
|
filter?: QueryDslQueryContainer
|
|
query: string
|
|
time_zone?: <<TimeZone>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `SqlTranslateResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SqlTranslateResponse {
|
|
aggregations?: Record<string, AggregationsAggregationContainer>
|
|
size?: <<long>>
|
|
_source?: SearchSourceConfig
|
|
fields?: (QueryDslFieldAndFormat | <<Field>>)[]
|
|
query?: QueryDslQueryContainer
|
|
sort?: <<Sort>>
|
|
}
|
|
----
|
|
|