From 6243d375eb8314a4dc8e8bf9b369ba2754d68b14 Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Thu, 7 Jan 2016 10:19:24 -0500 Subject: [PATCH] Add documentation for global search timeout MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit adds documentation for the global search timeout setting “search.default_search_timeout”. --- docs/reference/search.asciidoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/reference/search.asciidoc b/docs/reference/search.asciidoc index da7d2e5ee4b..a4de20ee213 100644 --- a/docs/reference/search.asciidoc +++ b/docs/reference/search.asciidoc @@ -73,6 +73,19 @@ the request with two different groups: } -------------------------------------------------- +[float] +[[global-search-timeout]] +== Global Search Timeout + +Individual searches can have a timeout as part of the +<>. Since search requests can originate from many +sources, Elasticsearch has a dynamic cluster-level setting for a global +search timeout that applies to all search requests that do not set a +timeout in the <>. The default value is no global +timeout. The setting key is `search.default_search_timeout` and can be +set using the <> endpoints. Setting this value +to `-1` resets the global search timeout to no timeout. + -- include::search/search.asciidoc[]