Add geohash, geotile, and geobounds aggregation on geoshapes documentation #4517
+575
−7
Conversation
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
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
requested review from
cwillum,
hdhalter,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
|
@navneet1v I've verified all requests against the endpoint you provided and they all work. Could you review this PR for technical accuracy please? |
kolchfa-aws
changed the title
kolchfa-aws
added
3 - Tech review
navneet1v
approved these changes
Jul 15, 2023
kolchfa-aws
added
4 - Doc review
Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
natebower
reviewed
Jul 17, 2023
There was a problem hiding this comment.
@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
|
|
||
| ## Aggregating geoshapes | ||
|
|
||
| To aggregate on geoshape fields, first create an index and map the `location` field as a `geo_shape`: |
There was a problem hiding this comment.
"To run an aggregation on a geoshape field"?
| @@ -8,7 +8,7 @@ nav_order: 80 | |||
|
|
|||
| # Geohash grid aggregations | |||
|
|
|||
| The `geohash_grid` aggregation buckets documents for geographical analysis. It organizes a geographical region into a grid of smaller regions of different sizes or precisions. Lower values of precision represent larger geographical areas and higher values represent smaller, more precise geographical areas. | |||
| The `geohash_grid` aggregation buckets documents for geographical analysis. It organizes a geographical region into a grid of smaller regions of different sizes or precisions. Lower values of precision represent larger geographical areas and higher values represent smaller, more precise geographical areas. You can aggregate documents on [geopoint]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-point/) or [geoshape]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-shape/) fields using a geohash grid aggregation. One notable difference is that a geopoint is only present in one bucket, but a geoshape is counted in all geohash grid cells with which it intersects. | |||
There was a problem hiding this comment.
"You can run a document aggregation on a geopoint or geoshape field..."?
| ## Aggregating geoshapes | ||
|
|
||
| To aggregate on geoshape fields, first create an index and map the `location` field as a `geo_shape`: |
There was a problem hiding this comment.
"To run an aggregation on a geoshape field"?
| {% include copy-curl.html %} | ||
|
|
||
| The optional `wrap_longitude` parameter specifies whether the bounding box returned by the aggregation can overlap the international date line (180° meridian). If `wrap_longitude` is set to `true`, the bounding box can overlap the international date line and return a bounds where the lower-left longitude is larger than the upper-right longitude. The default value for `wrap_longitude` is `true`. |
There was a problem hiding this comment.
"return a bounds" reads oddly to me. Do we mean "return boundaries"?
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
prudhvigodithi
added
3 - Done
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
…ation (opensearch-project#4517) * Add geohash and geotile grid aggregation on geoshapes documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add copy buttons and details blocks Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add note about geoshape agg not supported for visualizations Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _query-dsl/aggregations/bucket/geohash-grid.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reworded bounds Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli
added a commit
that referenced
this pull request
Dec 21, 2023
…ation (#4517) * Add geohash and geotile grid aggregation on geoshapes documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add copy buttons and details blocks Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add note about geoshape agg not supported for visualizations Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _query-dsl/aggregations/bucket/geohash-grid.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reworded bounds Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #861
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.