Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Clarify supported parameters for terms value source #81775

Merged
merged 1 commit into from
Dec 15, 2021
Merged

[DOCS] Clarify supported parameters for terms value source #81775

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/reference/aggregations/bucket/composite-aggregation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The `sources` parameter can be any of the following types:
[[_terms]]
===== Terms

The `terms` value source is equivalent to a simple `terms` aggregation.
The `terms` value source is similar to a simple `terms` aggregation.
The values are extracted from a field exactly like the `terms` aggregation.

Example:
Expand Down Expand Up @@ -205,6 +205,13 @@ GET /_search
----
////

Although similar, the `terms` value source doesn't support the same set of
parameters as the `terms` aggregation. For other supported value source
parameters, see:

* <<_order>>
* <<_missing_bucket>>

[[_histogram]]
===== Histogram

Expand Down Expand Up @@ -556,6 +563,7 @@ GET /_search
}
--------------------------------------------------

[[_order]]
==== Order

By default the composite buckets are sorted by their natural ordering. Values are sorted
Expand Down Expand Up @@ -588,6 +596,7 @@ GET /_search
\... will sort the composite bucket in descending order when comparing values from the `date_histogram` source
and in ascending order when comparing values from the `terms` source.

[[_missing_bucket]]
==== Missing bucket

By default documents without a value for a given source are ignored.
Expand Down