From fe351f14e815583c4852511ba1d54976dfcc5d81 Mon Sep 17 00:00:00 2001 From: Adrien Grand Date: Tue, 21 Jan 2014 15:40:44 +0100 Subject: [PATCH] Document `index.shard.check_on_startup`. --- docs/reference/index-modules.asciidoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/reference/index-modules.asciidoc b/docs/reference/index-modules.asciidoc index 39e224c6930..d7fb7ce91bc 100644 --- a/docs/reference/index-modules.asciidoc +++ b/docs/reference/index-modules.asciidoc @@ -41,6 +41,19 @@ otherwise it is written in non-compound format. added[0.90.2] refresh operation will be executed. Defaults to `1s`. Can be set to `-1` in order to disable it. +`index.shard.check_on_startup`:: + Should shard consistency be checked upon opening. + When `true`, the shard will be checked, preventing it from being open in + case some segments appear to be corrupted. + When `fix`, the shard will also be checked but segments that were reported + as corrupted will be automatically removed. + Default value is `false`, which doesn't check shards. + +NOTE: Checking shards may take a lot of time on large indices. + +WARNING: Setting `index.shard.check_on_startup` to `fix` may result in data loss, + use with caution. + -- include::index-modules/analysis.asciidoc[]