stack es update cli command
elastic stack es update --id <id> --index <index> [options]
Update a document.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--idstringrequired- A unique identifier for the document to be updated.
--indexstringrequired- The name of the target index. By default, the index is created automatically if it doesn't exist.
--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.
--include-source-on-error- True or false if to include the document source in the error message in case of parsing errors.
--langstring- The script language.
--refreshenum-
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.
Values: true, false, wait_for
--require-alias- If
true, the destination must be an index alias. --retry-on-conflictnumber- The number of times the operation should be retried when a conflict occurs.
--routingstring-
A custom value used to route operations to a specific shard. Not allowed when
index.slice.enabledistruefor the target index; use_sliceinstead.Repeatable: pass
--routingmultiple times to supply more than one value --timeoutstring- The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur.
--wait-for-active-shardsstring- The number of copies of each shard that must be active before proceeding with the operation.
Set to 'all' or 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. --sourcestring- If
false, turn off source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. --source-excludesstring-
The source fields you want to exclude.
Repeatable: pass
--source-excludesmultiple times to supply more than one value --source-includesstring-
The source fields you want to retrieve.
Repeatable: pass
--source-includesmultiple times to supply more than one value --detect-noop- If
true, theresultin the response is set tonoop(no operation) when there are no changes to the document. --docstring- A partial update to an existing document.
If both
docandscriptare specified,docis ignored. --doc-as-upsert- If
true, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines withdoc_as_upsertis not supported. --scriptstring- The script to run to update the document.
--scripted-upsert- If
true, run the script whether or not the document exists. --upsertstring- If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run.
--error-trace- When set to
trueElasticsearch will include the full stack trace of errors when they occur. --filter-pathstring-
Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
Repeatable: pass
--filter-pathmultiple times to supply more than one value --human- When set to
truewill return statistics in a format suitable for humans. For example"exists_time": "1h"for humans and"exists_time_in_millis": 3600000for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. --pretty- If set to
truethe returned JSON will be "pretty-formatted". Only use this option for debugging only. --input-filestring- 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