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

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

@ -85,9 +85,10 @@ 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.
Cell dimensions vary with latitude and so the table is for the worst-case scenario at the equator.
[horizontal]
*GeoHash length*:: *Area width x height*
1:: 5,009.4km x 4,992.6km
@ -105,12 +106,22 @@ Cell dimensions vary with latitude and so the table is for the worst-case scenar
=== Options
==== Options
[horizontal]
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.
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.
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.
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.