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

EsqlQueryRequest [interface-EsqlQueryRequest]

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; } & { format?: never; delimiter?: never; drop_null_columns?: never; allow_partial_results?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; })
columnar	boolean	By default, ES
delimiter	string	The character to use between values within a CSV row. Only valid for the CSV format.
drop_null_columns	boolean	Should columns that are entirely null be removed from the columns and values portion of the results? Defaults to false. If true then the response will include an extra section under the name all_columns which has the name of all 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, e.g. json, 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.
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; } & { format?: never; delimiter?: never; drop_null_columns?: never; allow_partial_results?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: 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.