stack es esql async-query cli command

elastic stack es esql async-query --query <query> [options]
		

Run an async ES|QL query.

--query string required

The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.

--[no-]allow-partial-results

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.

--delimiter string

The character to use between values within a CSV row. It is valid only for the CSV format.

--[no-]drop-null-columns

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.

--format string

A short version of the Accept header, e.g. json, yaml. csv, tsv, and txt formats will return results in a tabular format, excluding other metadata fields from the response. For async requests, nothing will be returned if the async query doesn't finish within the timeout. The query ID and running status are available in the X-Elasticsearch-Async-Id and X-Elasticsearch-Async-Is-Running HTTP headers of the response, respectively.

--[no-]columnar

By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.

--filter string

Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.

--time-zone string

Sets the default timezone of the query.

--locale string

Returns results (especially dates) formatted per the conventions of the locale.

--params string[]

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.

--[no-]profile

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.

--tables string

Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name.

--[no-]include-ccs-metadata

When set to true and performing a cross-cluster/cross-project 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.

--[no-]include-execution-metadata

When set to true, 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. This is similar to include_ccs_metadata, but it also returns metadata when the query is not CCS/CPS

--wait-for-completion-timeout string

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.

--keep-alive string

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.

--[no-]keep-on-completion

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.

--input-file string

path to a JSON file to use as command input

-V --[no-]version

Print the Elastic CLI version

--config-file string

path to a config file (default: ~/.elasticrc.yml)

--use-context string

override the active context from the config file

--command-profile string

restrict available commands to a deployment profile (serverless, stack, default)

--[no-]json

output as JSON

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--[no-]dry-run

validate all inputs and exit without performing any action (preview changes without applying them)