elasticsearch-js/docs/reference/api/EsqlAsyncQueryRequest.md

EsqlAsyncQueryRequest [interface-EsqlAsyncQueryRequest]

Name	Type	Description
allow_partial_results	boolean	If true, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If false, the query will fail if there are any failures. To override the default behavior, you can set the esql.query.allow_partial_results cluster setting to false.
body	string	({ [key: string]: any; } & { allow_partial_results?: never; delimiter?: never; drop_null_columns?: never; format?: never; keep_alive?: never; keep_on_completion?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; wait_for_completion_timeout?: never; })
columnar	boolean	By default, ES
delimiter	string	The character to use between values within a CSV row. It is valid only for the CSV format.
drop_null_columns	boolean	Indicates whether columns that are entirely null will be removed from the columns and values portion of the results. If true, the response will include an extra section under the name all_columns which has the name of all the columns.
filter	QueryDslQueryContainer	Specify a Query DSL query in the filter parameter to filter the set of documents that an ES
format	EsqlEsqlFormat	A short version of the Accept header, for example json or yaml.
include_ccs_metadata	boolean	When set to true and performing a cross-cluster query, the response will include an extra _clusters object with information about the clusters that participated in the search along with info such as shards count.
keep_alive	Duration	The period for which the query and its results are stored in the cluster. The default period is five days. When this period expires, the query and its results are deleted, even if the query is still ongoing. If the keep_on_completion parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the wait_for_completion_timeout parameter, regardless of this value.
keep_on_completion	boolean	Indicates whether the query and its results are stored in the cluster. If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the wait_for_completion_timeout parameter.
locale	string
params	FieldValue[]	To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
profile	boolean	If provided and true the response will include an extra profile object with information on how the query was executed. This information is for human debugging and its format can change at any time but it can give some insight into the performance of each part of the query.
query	string	The ES
querystring	{ [key: string]: any; } & { allow_partial_results?: never; delimiter?: never; drop_null_columns?: never; format?: never; keep_alive?: never; keep_on_completion?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; wait_for_completion_timeout?: never; }	All values in querystring will be added to the request querystring.
tables	Record<string, Record<string, EsqlTableValuesContainer>>	Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name.
wait_for_completion_timeout	Duration	The period to wait for the request to finish. By default, the request waits for 1 second for the query results. If the query completes during this period, results are returned Otherwise, a query ID is returned that can later be used to retrieve the results.