honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation for global search timeout 

This commit adds documentation for the global search timeout setting
“search.default_search_timeout”.
This commit is contained in:
Jason Tedor 2016-01-07 10:19:24 -05:00
parent a583edb2df
commit 6243d375eb
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference/search.asciidoc
View File

@ -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
<<search-request-body>>. 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 <<search-request-body>>. The default value is no global
timeout. The setting key is `search.default_search_timeout` and can be
set using the <<cluster-update-settings>> endpoints. Setting this value
to `-1` resets the global search timeout to no timeout.
-- --
include::search/search.asciidoc[] include::search/search.asciidoc[]