Loading

stack es indices put-mapping cli command

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

Update field mappings.

--index string required

A comma-separated list of index names the mapping should be added to (supports wildcards). Use _all or omit to add the mapping on all indices.

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

--[no-]allow-no-indices
A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.
--expand-wildcards string

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

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

--[no-]ignore-unavailable
If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.
--master-timeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
--timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
--[no-]write-index-only
If true, the mappings are applied only to the current write index for the target.
--[no-]date-detection
Controls whether dynamic date detection is enabled.
--[no-]dynamic
Controls whether new fields are added dynamically.
--dynamic-date-formats string[]
If date detection is enabled then new string fields are checked against 'dynamic_date_formats' and if the value matches then a new date field is added instead of string.
--dynamic-templates string[]
Specify dynamic templates for the mapping.
--field-names string
Control whether field names are enabled for the index.
--meta string
A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata.
--[no-]numeric-detection
Automatically map strings into numeric data types for all fields.
--properties string
Mapping for a field. For new fields, this mapping can include: - Field name - Field data type - Mapping parameters
--routing string
Enable making a routing value required on indexed documents.
--source string
Control whether the _source field is enabled on the index.
--runtime string
Mapping of runtime fields for the index.
--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)