Split query DSL, analyzer, and aggregation sections and add more to analyzer section #4693
+624
−276
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| layout: default | ||
| title: Bucket aggregations | ||
| has_children: true | ||
| has_toc: false | ||
| nav_order: 3 | ||
| redirect_from: | ||
| - /opensearch/bucket-agg/ | ||
| - /query-dsl/aggregations/bucket-agg/ | ||
| - /query-dsl/aggregations/bucket/ | ||
| - /aggregations/bucket-agg/ | ||
| --- | ||
|
|
||
| # Bucket aggregations | ||
|
|
||
| Bucket aggregations categorize sets of documents as buckets. The type of bucket aggregation determines whether a given document falls into a bucket or not. | ||
|
|
||
| You can use bucket aggregations to implement faceted navigation (usually placed as a sidebar on a search result landing page) to help your users narrow down the results. | ||
|
There was a problem hiding this comment. "filter" instead of "narrow down"? |
||
|
|
||
| ## Supported bucket aggregations | ||
|
|
||
| OpenSearch supports the following bucket aggregations: | ||
|
|
||
| - [Adjacency matrix]({{site.url}}{{site.baseurl}}/aggregations/bucket/adjacency-matrix/) | ||
| - [Date histogram]({{site.url}}{{site.baseurl}}/aggregations/bucket/date-histogram/) | ||
| - [Date range]({{site.url}}{{site.baseurl}}/aggregations/bucket/date-range/) | ||
| - [Diversified sampler]({{site.url}}{{site.baseurl}}/aggregations/bucket/diversified-sampler/) | ||
| - [Filter]({{site.url}}{{site.baseurl}}/aggregations/bucket/filter/) | ||
| - [Filters]({{site.url}}{{site.baseurl}}/aggregations/bucket/filters/) | ||
| - [Geodistance]({{site.url}}{{site.baseurl}}/aggregations/bucket/geo-distance/) | ||
| - [Geohash grid]({{site.url}}{{site.baseurl}}/aggregations/bucket/geohash-grid/) | ||
| - [Geohex grid]({{site.url}}{{site.baseurl}}/aggregations/bucket/geohex-grid/) | ||
| - [Geotile grid]({{site.url}}{{site.baseurl}}/aggregations/bucket/geotile-grid/) | ||
| - [Global]({{site.url}}{{site.baseurl}}/aggregations/bucket/global/) | ||
| - [Histogram]({{site.url}}{{site.baseurl}}/aggregations/bucket/histogram/) | ||
| - [IP range]({{site.url}}{{site.baseurl}}/aggregations/bucket/ip-range/) | ||
| - [Missing]({{site.url}}{{site.baseurl}}/aggregations/bucket/missing/) | ||
| - [Multi-terms]({{site.url}}{{site.baseurl}}/aggregations/bucket/multi-terms/) | ||
| - [Nested]({{site.url}}{{site.baseurl}}/aggregations/bucket/nested/) | ||
| - [Range]({{site.url}}{{site.baseurl}}/aggregations/bucket/range/) | ||
| - [Reverse nested]({{site.url}}{{site.baseurl}}/aggregations/bucket/reverse-nested/) | ||
| - [Sampler]({{site.url}}{{site.baseurl}}/aggregations/bucket/sampler/) | ||
| - [Significant terms]({{site.url}}{{site.baseurl}}/aggregations/bucket/significant-terms/) | ||
| - [Significant text]({{site.url}}{{site.baseurl}}/aggregations/bucket/significant-text/) | ||
| - [Terms]({{site.url}}{{site.baseurl}}/aggregations/bucket/terms/) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| layout: default | ||
| title: Metric aggregations | ||
| has_children: true | ||
| has_toc: false | ||
| nav_order: 2 | ||
| redirect_from: | ||
| - /opensearch/metric-agg/ | ||
| - /query-dsl/aggregations/metric-agg/ | ||
| - /aggregations/metric-agg/ | ||
| - /query-dsl/aggregations/metric/ | ||
| --- | ||
|
|
||
| # Metric aggregations | ||
|
|
||
| Metric aggregations let you perform simple calculations such as finding the minimum, maximum, and average values of a field. | ||
|
|
||
| ## Types of metric aggregations | ||
|
|
||
| Metric aggregations are of two types: single-value metric aggregations and multi-value metric aggregations. | ||
kolchfa-aws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Single-value metric aggregations | ||
|
|
||
| Single-value metric aggregations return a single metric. For example, `sum`, `min`, `max`, `avg`, `cardinality`, and `value_count`. | ||
kolchfa-aws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Multi-value metric aggregations | ||
|
|
||
| Multi-value metric aggregations return more than one metric. For example, `stats`, `extended_stats`, `matrix_stats`, `percentile`, `percentile_ranks`, `geo_bound`, `top_hits`, and `scripted_metric`. | ||
kolchfa-aws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Supported metric aggregations | ||
|
|
||
| OpenSearch supports the following metric aggregations: | ||
|
|
||
| - [Average]({{site.url}}{{site.baseurl}}/aggregations/metric/average/) | ||
| - [Cardinality]({{site.url}}{{site.baseurl}}/aggregations/metric/cardinality/) | ||
| - [Extended stats]({{site.url}}{{site.baseurl}}/aggregations/metric/extended-stats/) | ||
| - [Geobounds]({{site.url}}{{site.baseurl}}/aggregations/metric/geobounds/) | ||
| - [Matrix stats]({{site.url}}{{site.baseurl}}/aggregations/metric/matrix-stats/) | ||
| - [Maximum]({{site.url}}{{site.baseurl}}/aggregations/metric/maximum/) | ||
| - [Minimum]({{site.url}}{{site.baseurl}}/aggregations/metric/minimum/) | ||
| - [Percentile ranks]({{site.url}}{{site.baseurl}}/aggregations/metric/percentile-ranks/) | ||
| - [Percentile]({{site.url}}{{site.baseurl}}/aggregations/metric/percentile/) | ||
| - [Scripted metric]({{site.url}}{{site.baseurl}}/aggregations/metric/scripted-metric/) | ||
| - [Stats]({{site.url}}{{site.baseurl}}/aggregations/metric/stats/) | ||
| - [Sum]({{site.url}}{{site.baseurl}}/aggregations/metric/sum/) | ||
| - [Top hits]({{site.url}}{{site.baseurl}}/aggregations/metric/top-hits/) | ||
| - [Value count]({{site.url}}{{site.baseurl}}/aggregations/metric/value-count/) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer that we not use the phrasal verb "falls into". Would something like "The type of bucket aggregation determines into which bucket a given document is categorized" work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reworded.