Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Asymmetry between supported point format in geo_point and geo_shape field types #47535

Closed
talevy opened this issue Oct 3, 2019 · 6 comments · Fixed by #86835
Closed

Asymmetry between supported point format in geo_point and geo_shape field types #47535

talevy opened this issue Oct 3, 2019 · 6 comments · Fixed by #86835
Assignees
Labels
:Analytics/Geo Indexing, search aggregations of geo points and shapes >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo)

Comments

@talevy
Copy link
Contributor

talevy commented Oct 3, 2019

Right now geo_point can be defined in multiple formats:

  • "POINT(0 0)", WKT
  • { "lat": 0, "lon": 0}, lat/lon object
  • [0, 0], [lon, lat] array
  • "0, 0", (lat, lon) string
  • "gbsuv", geohash

Since geo_shape supports point types, it may make sense to also support geo_point formats as field values for this field type.

relates to #47243, where it would be nice to match either geo_point or geo_shape values.

@talevy talevy added >non-issue :Analytics/Geo Indexing, search aggregations of geo points and shapes team-discuss labels Oct 3, 2019
@talevy
Copy link
Contributor Author

talevy commented Oct 9, 2019

We discussed this in our Analytics/Geo team meeting and concluded that it would be clearer if the parsing of geo fields were consolidated together. This means that all valid geo_point field value formats will also be valid geo_shape field value formats, which will be indexed as Point/MultiPoint geometries. This will enable more flexible support for indexing the same field as both geo_point and geo_shape without modifying the value (even as a multi-field).

As part of this, GeoJSON will also be supported by the geo_point field (see #47815).

@craigtaverner
Copy link
Contributor

craigtaverner commented Mar 23, 2022

The related work in #84599 adds GeoJSON support to geo_point, but does not add the missing point formats to geo_shape, so we re-discussed this in the Analytics/Geo team meeting, and the consensus was that expanding geo_shape format support was not valuable, and in fact expanding support comes with the need to maintain that long term, so it was not desirable. In fact it was even suggested to deprecate the older point formats from geo_point.

However, the work involved in deprecation is high, and there is a definite risk that existing users will be impacted by such a change. The final position is to not fix this issue. Neither by adding old point formats to geo_shape, nor by deprecating the older point formats. Instead we will review all documentation and down-prioritize the older point formats (remove from examples that do not explicitly need them, replacing with WTK or GeoJSON). This issue then becomes a documentation issue. And the older formats are kind-of soft-deprecated. Still supported, but not preferred.

@craigtaverner craigtaverner added >docs General docs changes and removed >enhancement Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Mar 23, 2022
@craigtaverner craigtaverner self-assigned this Mar 23, 2022
@craigtaverner craigtaverner changed the title Add geo_point format parsing support for geo_shape field type Asymmetry between supported point format in geo_point and geo_shape field types Mar 23, 2022
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Mar 23, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@craigtaverner
Copy link
Contributor

craigtaverner commented Apr 28, 2022

Documentation PR at #86066 takes us one step closer, by adding descriptions for GeoJSON to geo_point and point (so more similar to geo_shape), but we still need to remove documentation for the older, soft-deprecated, formats.

@lockewritesdocs lockewritesdocs added Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) and removed Team:Docs Meta label for docs team labels Apr 28, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo (Team:Analytics)

@craigtaverner
Copy link
Contributor

A new PR should address this issue: #86835

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/Geo Indexing, search aggregations of geo points and shapes >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants