mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 05:58:44 +00:00
95f46f1212
We now have a very useful annotation to mark features or parameters as experimental. Let's use it! This commit replaces some custom text warnings with this annotation and adds this annotation to some existing features/parameters: - inner_hits (unreleased yet) - terminate_after (released in 1.4) - per-bucket doc count errors in the terms agg (released in 1.4) I also tagged with this annotation settings which should either be not needed (like the ability to evict entries from the filter cache based on time) or that are too deep into the way that Elasticsearch works like the Directory implementation or merge settings. Close #9563
56 lines
1.4 KiB
Plaintext
56 lines
1.4 KiB
Plaintext
[[search-aggregations-metrics-geobounds-aggregation]]
|
|
=== Geo Bounds Aggregation
|
|
|
|
experimental[]
|
|
|
|
A metric aggregation that computes the bounding box containing all geo_point values for a field.
|
|
|
|
|
|
Example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"query" : {
|
|
"match" : { "business_type" : "shop" }
|
|
},
|
|
"aggs" : {
|
|
"viewport" : {
|
|
"geo_bounds" : {
|
|
"field" : "location", <1>
|
|
"wrap_longitude" : true <2>
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
<1> The `geo_bounds` aggregation specifies the field to use to obtain the bounds
|
|
<2> `wrap_longitude` is an optional parameter which specifies whether the bounding box should be allowed to overlap the international date line. The default value is `true`
|
|
|
|
The above aggregation demonstrates how one would compute the bounding box of the location field for all documents with a business type of shop
|
|
|
|
The response for the above aggregation:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
...
|
|
|
|
"aggregations": {
|
|
"viewport": {
|
|
"bounds": {
|
|
"top_left": {
|
|
"lat": 80.45,
|
|
"lon": -160.22
|
|
},
|
|
"bottom_right": {
|
|
"lat": 40.65,
|
|
"lon": 42.57
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|