bucket.asciidoc 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. [[search-aggregations-bucket]]
  2. == Bucket Aggregations
  3. Bucket aggregations don't calculate metrics over fields like the metrics aggregations do, but instead, they create
  4. buckets of documents. Each bucket is associated with a criterion (depending on the aggregation type) which determines
  5. whether or not a document in the current context "falls" into it. In other words, the buckets effectively define document
  6. sets. In addition to the buckets themselves, the `bucket` aggregations also compute and return the number of documents
  7. that "fell into" each bucket.
  8. Bucket aggregations, as opposed to `metrics` aggregations, can hold sub-aggregations. These sub-aggregations will be
  9. aggregated for the buckets created by their "parent" bucket aggregation.
  10. There are different bucket aggregators, each with a different "bucketing" strategy. Some define a single bucket, some
  11. define fixed number of multiple buckets, and others dynamically create the buckets during the aggregation process.
  12. NOTE: The maximum number of buckets allowed in a single response is limited by a dynamic cluster
  13. setting named `search.max_buckets`. It defaults to 10,000, requests that try to return more than
  14. the limit will fail with an exception.
  15. include::bucket/adjacency-matrix-aggregation.asciidoc[]
  16. include::bucket/autodatehistogram-aggregation.asciidoc[]
  17. include::bucket/children-aggregation.asciidoc[]
  18. include::bucket/composite-aggregation.asciidoc[]
  19. include::bucket/datehistogram-aggregation.asciidoc[]
  20. include::bucket/daterange-aggregation.asciidoc[]
  21. include::bucket/diversified-sampler-aggregation.asciidoc[]
  22. include::bucket/filter-aggregation.asciidoc[]
  23. include::bucket/filters-aggregation.asciidoc[]
  24. include::bucket/geodistance-aggregation.asciidoc[]
  25. include::bucket/geohashgrid-aggregation.asciidoc[]
  26. include::bucket/global-aggregation.asciidoc[]
  27. include::bucket/histogram-aggregation.asciidoc[]
  28. include::bucket/iprange-aggregation.asciidoc[]
  29. include::bucket/missing-aggregation.asciidoc[]
  30. include::bucket/nested-aggregation.asciidoc[]
  31. include::bucket/parent-aggregation.asciidoc[]
  32. include::bucket/range-aggregation.asciidoc[]
  33. include::bucket/reverse-nested-aggregation.asciidoc[]
  34. include::bucket/sampler-aggregation.asciidoc[]
  35. include::bucket/significantterms-aggregation.asciidoc[]
  36. include::bucket/significanttext-aggregation.asciidoc[]
  37. include::bucket/terms-aggregation.asciidoc[]