From 582b3c06b6dab6f9be32ea63eba405b855a939c8 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Tue, 2 May 2017 14:25:03 +0200 Subject: [PATCH] Added docs for batched_reduce_size Relates to #23288 --- docs/reference/search/request-body.asciidoc | 8 ++++++++ docs/reference/search/uri-request.asciidoc | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/docs/reference/search/request-body.asciidoc b/docs/reference/search/request-body.asciidoc index 13df8d471eb..8e90711df95 100644 --- a/docs/reference/search/request-body.asciidoc +++ b/docs/reference/search/request-body.asciidoc @@ -93,6 +93,14 @@ And here is a sample response: the query execution has actually terminated_early. Defaults to no terminate_after. +`batched_reduce_size`:: + + The number of shard results that should be reduced at once on the + coordinating node. This value should be used as a protection mechanism to + reduce the memory overhead per search request if the potential number of + shards in the request can be large. + + Out of the above, the `search_type` and the `request_cache` must be passed as query-string parameters. The rest of the search request should be passed diff --git a/docs/reference/search/uri-request.asciidoc b/docs/reference/search/uri-request.asciidoc index 6670b9f31d5..9010db8e0a1 100644 --- a/docs/reference/search/uri-request.asciidoc +++ b/docs/reference/search/uri-request.asciidoc @@ -67,6 +67,11 @@ query. |`analyze_wildcard` |Should wildcard and prefix queries be analyzed or not. Defaults to `false`. +|`batched_reduce_size` | The number of shard results that should be reduced +at once on the coordinating node. This value should be used as a protection +mechanism to reduce the memory overhead per search request if the potential +number of shards in the request can be large. + |`default_operator` |The default operator to be used, can be `AND` or `OR`. Defaults to `OR`.