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.
--indexstringrequired- 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 adata_streamdefinition, 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. --documentstringrequired--idstring- 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-termnumber- Only perform the operation if the document has this primary term.
--if-seq-nonumber- 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-typestring- Set to
createto only index the document if it does not already exist (put if absent). If a document with the specified_idalready exists, the indexing operation will fail. The behavior is the same as using the<index>/_createendpoint. If a document ID is specified, this paramater defaults toindex. Otherwise, it defaults tocreate. If the request targets a data stream, anop_typeofcreateis required. --pipelinestring- 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
_nonedisables 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. Ifwait_for, it waits for a refresh to make this operation visible to search. Iffalse, it does nothing with refreshes. --routingstring-
A custom value that is used to route operations to a specific shard.
Repeatable: pass
--routingmultiple times to supply more than one value --timeoutstring- 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.
--versionnumber- An explicit version number for concurrency control. It must be a non-negative long number.
--version-typestring- The version type.
--wait-for-active-shardsnumber- The number of shard copies that must be active before proceeding with the operation. You can set it to
allor any positive integer up to the total number of shards in the index (number_of_replicas+1). The default value of1means 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-filestring- path to a JSON file to use as command input
-V--[no-]version- Print the Elastic CLI version
--config-filestring- path to a config file (default: ~/.elasticrc.yml)
--use-contextstring- override the active context from the config file
--command-profilestring- restrict available commands to a deployment profile (serverless, stack, default)
--[no-]json- output as JSON
--output-fieldsstring- comma-separated list of fields to include in output (dot-notation supported)
--output-templatestring- 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)