Type to search.

stack es mget cli command

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Auth required Idempotent Scope: global
Shell
elastic stack es mget [options]

Get multiple documents.

Behaviour flags:

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

--preference string
Specifies the node or shard the operation should be performed on. Random by default.
--realtime
If true, the request is real-time as opposed to near-real-time.
--refresh
If true, the request refreshes relevant shards before retrieving documents.
--routing string

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.

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

If true, retrieves the document fields stored in the index rather than the document _source.

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

--docs string[]

The documents you want to retrieve. Required if no index is specified in the request URI.

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

--ids string

The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.

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

--index string
Name of the index to retrieve documents from when ids are specified, or when a document in the docs array does not specify an index.
--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)
--no-validate
skip input validation and send the request as-is
--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}}")
--json

output as JSON