Skip to content

Commit 83e204d

Browse files
Added docs for batched_reduce_size
Relates to #23288
1 parent 0133879 commit 83e204d

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/reference/search/request-body.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ And here is a sample response:
9393
the query execution has actually terminated_early. Defaults to no
9494
terminate_after.
9595

96+
`batched_reduce_size`::
97+
98+
The number of shard results that should be reduced at once on the
99+
coordinating node. This value should be used as a protection mechanism to
100+
reduce the memory overhead per search request if the potential number of
101+
shards in the request can be large.
102+
103+
96104

97105
Out of the above, the `search_type` and the `request_cache` must be passed as
98106
query-string parameters. The rest of the search request should be passed

docs/reference/search/uri-request.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ query.
6767
|`analyze_wildcard` |Should wildcard and prefix queries be analyzed or
6868
not. Defaults to `false`.
6969

70+
|`batched_reduce_size` | The number of shard results that should be reduced
71+
at once on the coordinating node. This value should be used as a protection
72+
mechanism to reduce the memory overhead per search request if the potential
73+
number of shards in the request can be large.
74+
7075
|`default_operator` |The default operator to be used, can be `AND` or
7176
`OR`. Defaults to `OR`.
7277

0 commit comments

Comments
 (0)