[DOCS] Added "Aggregation" to all aggs titles
This commit is contained in:
Clinton Gormley
parent
dfdc183ba6
commit
5b93255ec8
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-datehistogram-aggregation]]
|
[[search-aggregations-bucket-datehistogram-aggregation]]
|
||||||
=== Date Histogram
|
=== Date Histogram Aggregation
|
||||||
|
|
||||||
A multi-bucket aggregation similar to the <<search-aggregations-bucket-histogram-aggregation,histogram>> except it can
|
A multi-bucket aggregation similar to the <<search-aggregations-bucket-histogram-aggregation,histogram>> except it can
|
||||||
only be applied on date values. Since dates are represented in elasticsearch internally as long values, it is possible
|
only be applied on date values. Since dates are represented in elasticsearch internally as long values, it is possible
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-daterange-aggregation]]
|
[[search-aggregations-bucket-daterange-aggregation]]
|
||||||
=== Date Range
|
=== Date Range Aggregation
|
||||||
|
|
||||||
A range aggregation that is dedicated for date values. The main difference between this aggregation and the normal <<search-aggregations-bucket-range-aggregation,range>> aggregation is that the `from` and `to` values can be expressed in Date Math expressions, and it is also possible to specify a date format by which the `from` and `to` response fields will be returned.
|
A range aggregation that is dedicated for date values. The main difference between this aggregation and the normal <<search-aggregations-bucket-range-aggregation,range>> aggregation is that the `from` and `to` values can be expressed in Date Math expressions, and it is also possible to specify a date format by which the `from` and `to` response fields will be returned.
|
||||||
Note that this aggregration includes the `from` value and excludes the `to` value for each range.
|
Note that this aggregration includes the `from` value and excludes the `to` value for each range.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-filter-aggregation]]
|
[[search-aggregations-bucket-filter-aggregation]]
|
||||||
=== Filter
|
=== Filter Aggregation
|
||||||
|
|
||||||
Defines a single bucket of all the documents in the current document set context that match a specified filter. Often this will be used to narrow down the current aggregation context to a specific set of documents.
|
Defines a single bucket of all the documents in the current document set context that match a specified filter. Often this will be used to narrow down the current aggregation context to a specific set of documents.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-geodistance-aggregation]]
|
[[search-aggregations-bucket-geodistance-aggregation]]
|
||||||
=== Geo Distance
|
=== Geo Distance Aggregation
|
||||||
|
|
||||||
A multi-bucket aggregation that works on `geo_point` fields and conceptually works very similar to the <<search-aggregations-bucket-range-aggregation,range>> aggregation. The user can define a point of origin and a set of distance range buckets. The aggregation evaluate the distance of each document value from the origin point and determines the buckets it belongs to based on the ranges (a document belongs to a bucket if the distance between the document and the origin falls within the distance range of the bucket).
|
A multi-bucket aggregation that works on `geo_point` fields and conceptually works very similar to the <<search-aggregations-bucket-range-aggregation,range>> aggregation. The user can define a point of origin and a set of distance range buckets. The aggregation evaluate the distance of each document value from the origin point and determines the buckets it belongs to based on the ranges (a document belongs to a bucket if the distance between the document and the origin falls within the distance range of the bucket).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-geohashgrid-aggregation]]
|
[[search-aggregations-bucket-geohashgrid-aggregation]]
|
||||||
=== GeoHash grid
|
=== GeoHash grid Aggregation
|
||||||
|
|
||||||
A multi-bucket aggregation that works on `geo_point` fields and groups points into buckets that represent cells in a grid.
|
A multi-bucket aggregation that works on `geo_point` fields and groups points into buckets that represent cells in a grid.
|
||||||
The resulting grid can be sparse and only contains cells that have matching data. Each cell is labeled using a http://en.wikipedia.org/wiki/Geohash[geohash] which is of user-definable precision.
|
The resulting grid can be sparse and only contains cells that have matching data. Each cell is labeled using a http://en.wikipedia.org/wiki/Geohash[geohash] which is of user-definable precision.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-global-aggregation]]
|
[[search-aggregations-bucket-global-aggregation]]
|
||||||
=== Global
|
=== Global Aggregation
|
||||||
|
|
||||||
Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you're searching on, but is *not* influenced by the search query itself.
|
Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you're searching on, but is *not* influenced by the search query itself.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-histogram-aggregation]]
|
[[search-aggregations-bucket-histogram-aggregation]]
|
||||||
=== Histogram
|
=== Histogram Aggregation
|
||||||
|
|
||||||
A multi-bucket values source based aggregation that can be applied on numeric values extracted from the documents.
|
A multi-bucket values source based aggregation that can be applied on numeric values extracted from the documents.
|
||||||
It dynamically builds fixed size (a.k.a. interval) buckets over the values. For example, if the documents have a field
|
It dynamically builds fixed size (a.k.a. interval) buckets over the values. For example, if the documents have a field
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-iprange-aggregation]]
|
[[search-aggregations-bucket-iprange-aggregation]]
|
||||||
=== IPv4 Range
|
=== IPv4 Range Aggregation
|
||||||
|
|
||||||
Just like the dedicated <<search-aggregations-bucket-daterange-aggregation,date>> range aggregation, there is also a dedicated range aggregation for IPv4 typed fields:
|
Just like the dedicated <<search-aggregations-bucket-daterange-aggregation,date>> range aggregation, there is also a dedicated range aggregation for IPv4 typed fields:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-missing-aggregation]]
|
[[search-aggregations-bucket-missing-aggregation]]
|
||||||
=== Missing
|
=== Missing Aggregation
|
||||||
|
|
||||||
A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set). This aggregator will often be used in conjunction with other field data bucket aggregators (such as ranges) to return information for all the documents that could not be placed in any of the other buckets due to missing field data values.
|
A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set). This aggregator will often be used in conjunction with other field data bucket aggregators (such as ranges) to return information for all the documents that could not be placed in any of the other buckets due to missing field data values.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-nested-aggregation]]
|
[[search-aggregations-bucket-nested-aggregation]]
|
||||||
=== Nested
|
=== Nested Aggregation
|
||||||
|
|
||||||
A special single bucket aggregation that enables aggregating nested documents.
|
A special single bucket aggregation that enables aggregating nested documents.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-range-aggregation]]
|
[[search-aggregations-bucket-range-aggregation]]
|
||||||
=== Range
|
=== Range Aggregation
|
||||||
|
|
||||||
A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. During the aggregation process, the values extracted from each document will be checked against each bucket range and "bucket" the relevant/matching document.
|
A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. During the aggregation process, the values extracted from each document will be checked against each bucket range and "bucket" the relevant/matching document.
|
||||||
Note that this aggregration includes the `from` value and excludes the `to` value for each range.
|
Note that this aggregration includes the `from` value and excludes the `to` value for each range.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-reverse-nested-aggregation]]
|
[[search-aggregations-bucket-reverse-nested-aggregation]]
|
||||||
=== Reverse nested
|
=== Reverse nested Aggregation
|
||||||
|
|
||||||
A special single bucket aggregation that enables aggregating on parent docs from nested documents. Effectively this
|
A special single bucket aggregation that enables aggregating on parent docs from nested documents. Effectively this
|
||||||
aggregation can break out of the nested block structure and link to other nested structures or the root document,
|
aggregation can break out of the nested block structure and link to other nested structures or the root document,
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-significantterms-aggregation]]
|
[[search-aggregations-bucket-significantterms-aggregation]]
|
||||||
=== Significant Terms
|
=== Significant Terms Aggregation
|
||||||
|
|
||||||
An aggregation that returns interesting or unusual occurrences of terms in a set.
|
An aggregation that returns interesting or unusual occurrences of terms in a set.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-bucket-terms-aggregation]]
|
[[search-aggregations-bucket-terms-aggregation]]
|
||||||
=== Terms
|
=== Terms Aggregation
|
||||||
|
|
||||||
A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.
|
A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-avg-aggregation]]
|
[[search-aggregations-metrics-avg-aggregation]]
|
||||||
=== Avg
|
=== Avg Aggregation
|
||||||
|
|
||||||
A `single-value` metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
A `single-value` metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-cardinality-aggregation]]
|
[[search-aggregations-metrics-cardinality-aggregation]]
|
||||||
=== Cardinality
|
=== Cardinality Aggregation
|
||||||
|
|
||||||
added[1.1.0]
|
added[1.1.0]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-extendedstats-aggregation]]
|
[[search-aggregations-metrics-extendedstats-aggregation]]
|
||||||
=== Extended Stats
|
=== Extended Stats Aggregation
|
||||||
|
|
||||||
A `multi-value` metrics aggregation that computes stats over numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
A `multi-value` metrics aggregation that computes stats over numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-max-aggregation]]
|
[[search-aggregations-metrics-max-aggregation]]
|
||||||
=== Max
|
=== Max Aggregation
|
||||||
|
|
||||||
A `single-value` metrics aggregation that keeps track and returns the maximum value among the numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
A `single-value` metrics aggregation that keeps track and returns the maximum value among the numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-min-aggregation]]
|
[[search-aggregations-metrics-min-aggregation]]
|
||||||
=== Min
|
=== Min Aggregation
|
||||||
|
|
||||||
A `single-value` metrics aggregation that keeps track and returns the minimum value among numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
A `single-value` metrics aggregation that keeps track and returns the minimum value among numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-percentile-aggregation]]
|
[[search-aggregations-metrics-percentile-aggregation]]
|
||||||
=== Percentiles
|
=== Percentiles Aggregation
|
||||||
|
|
||||||
added[1.1.0]
|
added[1.1.0]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-stats-aggregation]]
|
[[search-aggregations-metrics-stats-aggregation]]
|
||||||
=== Stats
|
=== Stats Aggregation
|
||||||
|
|
||||||
A `multi-value` metrics aggregation that computes stats over numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
A `multi-value` metrics aggregation that computes stats over numeric values extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-sum-aggregation]]
|
[[search-aggregations-metrics-sum-aggregation]]
|
||||||
=== Sum
|
=== Sum Aggregation
|
||||||
|
|
||||||
A `single-value` metrics aggregation that sums up numeric values that are extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
A `single-value` metrics aggregation that sums up numeric values that are extracted from the aggregated documents. These values can be extracted either from specific numeric fields in the documents, or be generated by a provided script.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[[search-aggregations-metrics-valuecount-aggregation]]
|
[[search-aggregations-metrics-valuecount-aggregation]]
|
||||||
=== Value Count
|
=== Value Count Aggregation
|
||||||
|
|
||||||
A `single-value` metrics aggregation that counts the number of values that are extracted from the aggregated documents.
|
A `single-value` metrics aggregation that counts the number of values that are extracted from the aggregated documents.
|
||||||
These values can be extracted either from specific fields in the documents, or be generated by a provided script. Typically,
|
These values can be extracted either from specific fields in the documents, or be generated by a provided script. Typically,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue