[Docs] Add `indices.query.bool.max_clause_count` setting (#34779)

This change adds a section about the global search setting
`indices.query.bool.max_clause_count` that limits the number of boolean clauses
allowed in a Lucene BooleanQuery.

Closes #19858
This commit is contained in:
Christoph Büscher 2018-10-25 17:59:59 +02:00 committed by GitHub
parent 3225b2dcd3
commit c0c6a28e86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions

View File

@ -30,6 +30,10 @@ Available settings include:
Control the resource limits on the shard recovery process. Control the resource limits on the shard recovery process.
<<search-settings,Search Settings>>::
Control global search settings.
include::indices/circuit_breaker.asciidoc[] include::indices/circuit_breaker.asciidoc[]
include::indices/fielddata.asciidoc[] include::indices/fielddata.asciidoc[]
@ -42,3 +46,5 @@ include::indices/request_cache.asciidoc[]
include::indices/recovery.asciidoc[] include::indices/recovery.asciidoc[]
include::indices/search-settings.asciidoc[]

View File

@ -0,0 +1,16 @@
[[search-settings]]
=== Search Settings
The following _expert_ setting can be set to manage global search limits.
`indices.query.bool.max_clause_count`::
Defaults to `1024`.
This setting limits the number of clauses a Lucene BooleanQuery can have. The
default of 1024 is quite high and should normally be sufficient. This limit does
not only affect Elasticsearchs `bool` query, but many other queries are rewritten to Lucene's
BooleanQuery internally. The limit is in place to prevent searches from becoming to large
and taking up too much CPU and memory. In case you consider to increase this setting,
make sure you exhausted all other options to avoid having to do this. Higher values can lead
to performance degradations and memory issues, especially in clusters with a high load or
few resources.