honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Tidied up geohashgrid aggregations

This commit is contained in:
Clinton Gormley 2014-02-04 11:54:32 +01:00
parent ba415b8ad2
commit 238b26a466
1 changed files with 35 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
docs/reference/search/aggregations/bucket/geohashgrid-aggregation.asciidoc
View File

@ -8,14 +8,14 @@ The resulting grid can be sparse and only contains cells that have matching data
* Low precision geohashes have a short string length and represent cells that each cover a large area. * Low precision geohashes have a short string length and represent cells that each cover a large area.
Geohashes used in this aggregation can have a choice of precision between 1 and 12. Geohashes used in this aggregation can have a choice of precision between 1 and 12.
WARNING: The highest-precision geohash of length 12 produces cells that cover less than a square metre of land and so high-precision requests can be very costly in terms of RAM and result sizes. WARNING: The highest-precision geohash of length 12 produces cells that cover less than a square metre of land and so high-precision requests can be very costly in terms of RAM and result sizes.
Please see the example below on how to first filter the aggregation to a smaller geographic area before requesting high-levels of detail. Please see the example below on how to first filter the aggregation to a smaller geographic area before requesting high-levels of detail.
The specified field must be of type `geo_point` (which can only be set explicitly in the mappings) and it can also hold an array of `geo_point` fields, in which case all points will be taken into account during aggregation. The specified field must be of type `geo_point` (which can only be set explicitly in the mappings) and it can also hold an array of `geo_point` fields, in which case all points will be taken into account during aggregation.
==== Simple low-precision request ==== Simple low-precision request
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -57,14 +57,14 @@ Response:
==== High-precision requests ==== High-precision requests
When requesting detailed buckets (typically for displaying a "zoomed in" map) a filter like <<query-dsl-geo-bounding-box-filter,geo_bounding_box>> should be applied to narrow the subject area otherwise potentially millions of buckets will be created and returned. When requesting detailed buckets (typically for displaying a "zoomed in" map) a filter like <<query-dsl-geo-bounding-box-filter,geo_bounding_box>> should be applied to narrow the subject area otherwise potentially millions of buckets will be created and returned.
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
{ {
"aggregations" : { "aggregations" : {
"zoomedInView" : { "zoomedInView" : {
"filter" : { "filter" : {
"geo_bounding_box" : { "geo_bounding_box" : {
"location" : { "location" : {
"top_left" : "51.73, 0.9", "top_left" : "51.73, 0.9",
@ -85,32 +85,43 @@ When requesting detailed buckets (typically for displaying a "zoomed in" map) a
} }
-------------------------------------------------- --------------------------------------------------
=== Cell dimensions at the equator ==== Cell dimensions at the equator
The table below shows the metric dimensions for cells covered by various string lengths of geohash. The table below shows the metric dimensions for cells covered by various string lengths of geohash.
Cell dimensions vary with latitude and so the table is for the worst-case scenario at the equator. Cell dimensions vary with latitude and so the table is for the worst-case scenario at the equator.
[horizontal] [horizontal]
*GeoHash length*:: *Area width x height* *GeoHash length*:: *Area width x height*
1:: 5,009.4km x 4,992.6km 1:: 5,009.4km x 4,992.6km
2:: 1,252.3km x 624.1km 2:: 1,252.3km x 624.1km
3:: 156.5km x 156km 3:: 156.5km x 156km
4:: 39.1km x 19.5km 4:: 39.1km x 19.5km
5:: 4.9km x 4.9km 5:: 4.9km x 4.9km
6:: 1.2km x 609.4m 6:: 1.2km x 609.4m
7:: 152.9m x 152.4m 7:: 152.9m x 152.4m
8:: 38.2m x 19m 8:: 38.2m x 19m
9:: 4.8m x 4.8m 9:: 4.8m x 4.8m
10:: 1.2m x 59.5cm 10:: 1.2m x 59.5cm
11:: 14.9cm x 14.9cm 11:: 14.9cm x 14.9cm
12:: 3.7cm x 1.9cm 12:: 3.7cm x 1.9cm
=== Options ==== Options
[horizontal] [horizontal]
field:: Mandatory. The name of the field indexed with GeoPoints. field:: Mandatory. The name of the field indexed with GeoPoints.
precision:: Optional. The string length of the geohashes used to define cells/buckets in the results. Defaults to 5.
size:: Optional. The maximum number of geohash buckets to return (defaults to 10,000). When results are trimmed, buckets are prioritised based on the volumes of documents they contain. precision:: Optional. The string length of the geohashes used to define
shard_size:: Optional. To allow for more accurate counting of the top cells returned in the final result the aggregation defaults to returning max(10,(size x number-of-shards)) buckets from each shard. If this heuristic is undesirable, the number considered from each shard can be over-ridden using this parameter. cells/buckets in the results. Defaults to 5.
size:: Optional. The maximum number of geohash buckets to return
(defaults to 10,000). When results are trimmed, buckets are
prioritised based on the volumes of documents they contain.
shard_size:: Optional. To allow for more accurate counting of the top cells
returned in the final result the aggregation defaults to
returning `max(10,(size x number-of-shards))` buckets from each
shard. If this heuristic is undesirable, the number considered
from each shard can be over-ridden using this parameter.