stack es search-template cli command

elastic stack es search-template [options]
		

Run a search with a search template.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--allow-no-indices

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

--ccs-minimize-roundtrips

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

--expand-wildcards enum

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Values: all, open, closed, hidden, none

Repeatable: pass --expand-wildcards multiple times to supply more than one value

--explain

If true, returns detailed information about score calculation as part of each hit. If you specify both this and the explain query parameter, the API uses only the query parameter.

--ignore-throttled

If true, specified concrete, expanded, or aliased indices are not included in the response when throttled.

--ignore-unavailable

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

--preference string

The node or shard the operation should be performed on. It is random by default.

--profile

If true, the query execution is profiled.

--routing string

A custom value used to route operations to a specific shard.

Repeatable: pass --routing multiple times to supply more than one value

--scroll string

Specifies how long a consistent view of the index should be maintained for scrolled search.

--search-type enum

The type of the search operation.

Values: query_then_fetch, dfs_query_then_fetch

--rest-total-hits-as-int

If true, hits.total is rendered as an integer in the response. If false, it is rendered as an object.

--typed-keys

If true, the response prefixes aggregation and suggester names with their respective types.

--id string

The ID of the search template to use. If no source is specified, this parameter is required.

--params string

Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.

--source string

An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no id is specified, this parameter is required.

--index string

A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*).

Repeatable: pass --index multiple times to supply more than one value

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

path to a JSON file to use as command input

--dry-run

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

--json

output as JSON