OpenSearch/docs/reference/modules/indices.asciidoc

[[modules-indices]]
== Indices

The indices module controls index-related settings that are globally managed
for all indices, rather than being configurable at a per-index level.

Available settings include:

<<circuit-breaker,Circuit breaker>>::

    Circuit breakers set limits on memory usage to avoid out of memory exceptions.

<<modules-fielddata,Fielddata cache>>::

    Set limits on the amount of heap used by the in-memory fielddata cache.

<<query-cache,Node query cache>>::

    Configure the amount heap used to cache queries results.

<<indexing-buffer,Indexing buffer>>::

    Control the size of the buffer allocated to the indexing process.

<<shard-request-cache,Shard request cache>>::

    Control the behaviour of the shard-level request cache.

<<recovery,Recovery>>::

    Control the resource limits on the shard recovery process.

include::indices/circuit_breaker.asciidoc[]

include::indices/fielddata.asciidoc[]

include::indices/query_cache.asciidoc[]

include::indices/indexing_buffer.asciidoc[]

include::indices/request_cache.asciidoc[]

include::indices/recovery.asciidoc[]
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`[[modules-indices]]`
			`== Indices`

Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`The indices module controls index-related settings that are globally managed`
			`for all indices, rather than being configurable at a per-index level.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`Available settings include:`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`<<circuit-breaker,Circuit breaker>>::`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`Circuit breakers set limits on memory usage to avoid out of memory exceptions.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`<<modules-fielddata,Fielddata cache>>::`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`Set limits on the amount of heap used by the in-memory fielddata cache.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Rename caches. In order to be more consistent with what they do, the query cache has been renamed to request cache and the filter cache has been renamed to query cache. A known issue is that package/logger names do no longer match settings names, please speak up if you think this is an issue. Here are the settings for which I kept backward compatibility. Note that they are a bit different from what was discussed on #11569 but putting `cache` before the name of what is cached has the benefit of making these settings consistent with the fielddata cache whose size is configured by `indices.fielddata.cache.size`: * index.cache.query.enable -> index.requests.cache.enable * indices.cache.query.size -> indices.requests.cache.size * indices.cache.filter.size -> indices.queries.cache.size Close #11569 2015-06-26 10:31:38 -04:00			`<<query-cache,Node query cache>>::`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Rename caches. In order to be more consistent with what they do, the query cache has been renamed to request cache and the filter cache has been renamed to query cache. A known issue is that package/logger names do no longer match settings names, please speak up if you think this is an issue. Here are the settings for which I kept backward compatibility. Note that they are a bit different from what was discussed on #11569 but putting `cache` before the name of what is cached has the benefit of making these settings consistent with the fielddata cache whose size is configured by `indices.fielddata.cache.size`: * index.cache.query.enable -> index.requests.cache.enable * indices.cache.query.size -> indices.requests.cache.size * indices.cache.filter.size -> indices.queries.cache.size Close #11569 2015-06-26 10:31:38 -04:00			`Configure the amount heap used to cache queries results.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`<<indexing-buffer,Indexing buffer>>::`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`Control the size of the buffer allocated to the indexing process.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Rename caches. In order to be more consistent with what they do, the query cache has been renamed to request cache and the filter cache has been renamed to query cache. A known issue is that package/logger names do no longer match settings names, please speak up if you think this is an issue. Here are the settings for which I kept backward compatibility. Note that they are a bit different from what was discussed on #11569 but putting `cache` before the name of what is cached has the benefit of making these settings consistent with the fielddata cache whose size is configured by `indices.fielddata.cache.size`: * index.cache.query.enable -> index.requests.cache.enable * indices.cache.query.size -> indices.requests.cache.size * indices.cache.filter.size -> indices.queries.cache.size Close #11569 2015-06-26 10:31:38 -04:00			`<<shard-request-cache,Shard request cache>>::`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Rename caches. In order to be more consistent with what they do, the query cache has been renamed to request cache and the filter cache has been renamed to query cache. A known issue is that package/logger names do no longer match settings names, please speak up if you think this is an issue. Here are the settings for which I kept backward compatibility. Note that they are a bit different from what was discussed on #11569 but putting `cache` before the name of what is cached has the benefit of making these settings consistent with the fielddata cache whose size is configured by `indices.fielddata.cache.size`: * index.cache.query.enable -> index.requests.cache.enable * indices.cache.query.size -> indices.requests.cache.size * indices.cache.filter.size -> indices.queries.cache.size Close #11569 2015-06-26 10:31:38 -04:00			`Control the behaviour of the shard-level request cache.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`<<recovery,Recovery>>::`
[DOCS] Document `indices.recovery.concurrent_small_file_streams` 2015-04-06 13:16:50 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`Control the resource limits on the shard recovery process.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`include::indices/circuit_breaker.asciidoc[]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`include::indices/fielddata.asciidoc[]`

Rename caches. In order to be more consistent with what they do, the query cache has been renamed to request cache and the filter cache has been renamed to query cache. A known issue is that package/logger names do no longer match settings names, please speak up if you think this is an issue. Here are the settings for which I kept backward compatibility. Note that they are a bit different from what was discussed on #11569 but putting `cache` before the name of what is cached has the benefit of making these settings consistent with the fielddata cache whose size is configured by `indices.fielddata.cache.size`: * index.cache.query.enable -> index.requests.cache.enable * indices.cache.query.size -> indices.requests.cache.size * indices.cache.filter.size -> indices.queries.cache.size Close #11569 2015-06-26 10:31:38 -04:00			`include::indices/query_cache.asciidoc[]`
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00
			`include::indices/indexing_buffer.asciidoc[]`

Rename caches. In order to be more consistent with what they do, the query cache has been renamed to request cache and the filter cache has been renamed to query cache. A known issue is that package/logger names do no longer match settings names, please speak up if you think this is an issue. Here are the settings for which I kept backward compatibility. Note that they are a bit different from what was discussed on #11569 but putting `cache` before the name of what is cached has the benefit of making these settings consistent with the fielddata cache whose size is configured by `indices.fielddata.cache.size`: * index.cache.query.enable -> index.requests.cache.enable * indices.cache.query.size -> indices.requests.cache.size * indices.cache.filter.size -> indices.queries.cache.size Close #11569 2015-06-26 10:31:38 -04:00			`include::indices/request_cache.asciidoc[]`
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00
			`include::indices/recovery.asciidoc[]`