stack es explain cli command

elastic stack es explain --id <id> --index <index> [options]
		

Explain a document match result.

Behaviour flags:

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

--id string required

The document identifier.

--index string required

Index names that are used to limit the request. Only a single index name can be provided to this parameter.

--analyzer string

The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.

--analyze-wildcard

If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.

--default-operator enum

The default operator for query string query: and or or. This parameter can be used only when the q query string parameter is specified.

Values: and, or

--df string

The field to use as default where no field prefix is given in the query string. This parameter can be used only when the q query string parameter is specified.

--lenient

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.

--preference string

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

--routing string

A custom value used to route operations to a specific shard. Not allowed when index.slice.enabled is true for the target index; use _slice instead.

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

--source string

True or false to return the _source field or not or a list of fields to return.

--source-excludes string

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

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

--source-includes string

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

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

--stored-fields string

A comma-separated list of stored fields to return in the response.

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

--q string

The query in the Lucene query string syntax.

--query string

Defines the search definition using the Query DSL.

--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