Browse Source

Adds a note in the `terms` aggregation docs regarding pagination (#28360)

This change adds a note in the `terms` aggregation that explains how to retrieve **all**
terms (or all combinations of terms in a nested agg) using the `composite` aggregation.
Jim Ferenczi 7 years ago
parent
commit
65184d0b5b
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/reference/aggregations/bucket/terms-aggregation.asciidoc

+ 5 - 0
docs/reference/aggregations/bucket/terms-aggregation.asciidoc

@@ -114,6 +114,11 @@ This means that if the number of unique terms is greater than `size`, the return
 (it could be that the term counts are slightly off and it could even be that a term that should have been in the top
 size buckets was not returned).
 
+NOTE: If you want to retrieve **all** terms or all combinations of terms in a nested `terms` aggregation
+      you should use the <<search-aggregations-bucket-composite-aggregation,Composite>> aggregation which
+      allows to paginate over all possible terms rather than setting a size greater than the cardinality of the field in the
+      `terms` aggregation. The `terms` aggregation is meant to return the `top` terms and does not allow pagination.
+
 [[search-aggregations-bucket-terms-aggregation-approximate-counts]]
 ==== Document counts are approximate