Skip to content

Commit f7c4740

Browse files
authored
Document that highlighting terms queries is best-effort. (#28371)
The `terms` query is really designed for filtering and highlighting it might cause performance issues if it wraps many terms, so I am documenting highlighting these queries as a best-effort only. Closes #28099
1 parent eea9ee5 commit f7c4740

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/reference/query-dsl/terms-query.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ GET /_search
1515
--------------------------------------------------
1616
// CONSOLE
1717

18+
NOTE: Highlighting `terms` queries is best-effort only, so terms of a `terms`
19+
query might not be highlighted depending on the highlighter implementation that
20+
is selected and on the number of terms in the `terms` query.
21+
1822
[float]
1923
[[query-dsl-terms-lookup]]
2024
===== Terms lookup mechanism

0 commit comments

Comments
 (0)