Index modulesedit


Index Settingsedit




Static index settingsedit




(default) Don’t check for corruption when opening a shard.
Check for physical corruption.


Expert only. Checking shards may take a lot of time on large indices.

Indicates whether cached filters are pre-loaded for nested queries. Possible values are true (default) and false.

Dynamic index settingsedit


Auto-expand the number of replicas based on the number of data nodes in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all). Defaults to false (i.e. disabled). Note that the auto-expanded number of replicas does not take any other allocation rules into account, such as shard allocation awareness, filtering or total shards per node, and this can lead to the cluster health becoming YELLOW if the applicable rules prevent all the replicas from being allocated.
How long a shard can not receive a search or get request until it’s considered search idle. (default is 30s)
How often to perform a refresh operation, which makes recent changes to the index visible to search. Defaults to 1s. Can be set to -1 to disable refresh. If this setting is not explicitly set, shards that haven’t seen search traffic for at least seconds will not receive background refreshes until they receive a search request. Searches that hit an idle shard where a refresh is pending will wait for the next background refresh (within 1s). This behavior aims to automatically optimize bulk indexing in the default case when no searches are performed. In order to opt out of this behavior an explicit value of 1s should set as the refresh interval.
The maximum value of from + size for inner hits definition and top hits aggregations to this index. Defaults to 100. Inner hits and top hits aggregation take heap memory and time proportional to from + size and this limits that memory.
The maximum number of docvalue_fields that are allowed in a query. Defaults to 100. Doc-value fields are costly since they might incur a per-field per-document seek.
The maximum number of script_fields that are allowed in a query. Defaults to 32.
The maximum allowed difference between min_gram and max_gram for NGramTokenizer and NGramTokenFilter. Defaults to 1.
The maximum allowed difference between max_shingle_size and min_shingle_size for ShingleTokenFilter. Defaults to 3.
Set to true to disable read operations against the index.
Set to true to disable data write operations against the index. Unlike read_only, this setting does not affect metadata. For instance, you can close an index with a write block, but not an index with a read_only block.
Set to true to disable index metadata reads and writes.
The maximum number of tokens that can be produced using _analyze API. Defaults to 10000.
The maximum number of characters that will be analyzed for a highlight request. This setting is only applicable when highlighting is requested on a text that was indexed without offsets or term vectors. Defaults to 1000000.
The maximum number of terms that can be used in Terms Query. Defaults to 65536.
The maximum length of regex that can be used in Regexp Query. Defaults to 1000.

Controls shard allocation for this index. It can be set to:

  • all (default) - Allows shard allocation for all shards.
  • primaries - Allows shard allocation only for primary shards.
  • new_primaries - Allows shard allocation only for newly-created primary shards.
  • none - No shard allocation is allowed.

Enables shard rebalancing for this index. It can be set to:

  • all (default) - Allows shard rebalancing for all shards.
  • primaries - Allows shard rebalancing only for primary shards.
  • replicas - Allows shard rebalancing only for replica shards.
  • none - No shard rebalancing is allowed.
The length of time that a deleted document’s version number remains available for further versioned operations. Defaults to 60s.
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist. The default may be overridden using the pipeline parameter. The special pipeline name _none indicates no ingest pipeline should be run.

Settings in other index modulesedit

Other index settings are available in index modules:

Index shard allocation
Enable or disable dynamic mapping for an index.
Control over how shards are merged by the background merge process.
Configure custom similarity settings to customize how search results are scored.
Control over how slow queries and fetch requests are logged.
Configure the type of filesystem used to access shard data.
Control over the transaction log and background flush operations.

X-Pack index settingsedit

Index lifecycle management
Specify the lifecycle policy and rollover alias for an index.