Loading

stack es index cli command

Auth required Idempotent Scope: global
elastic stack es index --index <index> --document <document> [options]
		

Create or update a document in an index.

--index string required
The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (*) pattern of an index template with a data_stream definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API.
--document string required
--id string
A unique identifier for the document. To automatically generate a document ID, use the POST /<target>/_doc/ request format and omit this parameter.
--if-primary-term number
Only perform the operation if the document has this primary term.
--if-seq-no number
Only perform the operation if the document has this sequence number.
--[no-]include-source-on-error
True or false if to include the document source in the error message in case of parsing errors.
--op-type string
Set to create to only index the document if it does not already exist (put if absent). If a document with the specified _id already exists, the indexing operation will fail. The behavior is the same as using the <index>/_create endpoint. If a document ID is specified, this paramater defaults to index. Otherwise, it defaults to create. If the request targets a data stream, an op_type of create is required.
--pipeline string
The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
--[no-]refresh
If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, it waits for a refresh to make this operation visible to search. If false, it does nothing with refreshes.
--routing string

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

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

--timeout string
The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.
--version number
An explicit version number for concurrency control. It must be a non-negative long number.
--version-type string
The version type.
--wait-for-active-shards number
The number of shard copies that must be active before proceeding with the operation. You can set it to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default value of 1 means it waits for each primary shard to be active.
--[no-]require-alias
If true, the destination must be an index alias.
--[no-]require-data-stream
If true, the request's actions must target a data stream (existing or to be created).
--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)