Skip to content

Update geo_shape docs to include unsupported features #38138

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 1, 2019
Merged

Update geo_shape docs to include unsupported features #38138

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b902fa
Update geo_shape docs to include unsupported features
nknize Jan 31, 2019
699f34b
update with PR feedback
nknize Feb 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/reference/mapping/types/geo-shape.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type.
|=======================================================================
|Option |Description| Default

|`tree |deprecated[6.6, PrefixTrees no longer used] Name of the PrefixTree
|`tree` |deprecated[6.6, PrefixTrees no longer used] Name of the PrefixTree
implementation to be used: `geohash` for GeohashPrefixTree and `quadtree`
for QuadPrefixTree. Note: This parameter is only relevant for `term` and
`recursive` strategies.
Expand Down Expand Up @@ -127,6 +127,20 @@ the `tree` or `strategy` parameters according to the appropriate
<<geo-shape-mapping-options>>. Note that these parameters are now deprecated
and will be removed in a future version.

*IMPORTANT NOTES*

The following features are not yet supported with the new indexing approach:

* `geo_shape` query with `MultiPoint` geometry types - Elasticsearch currently prevents searching
Copy link
Contributor

@jpountz jpountz Feb 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we actually raise an error if a user uses a multi-point to search, or do we return wrong results?

Copy link
Contributor Author

@nknize nknize Feb 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We issue a QueryShardException stating MultiPoint queries are not supported.

Copy link
Contributor

@jpountz jpountz Feb 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks for confirming.

geo_shape fields with a MultiPoint geometry type to avoid a brute force linear search
over each individual point. For now, if this is absolutely needed, this can be achieved
using a `bool` query with each individual point.

* `CONTAINS` relation query - when using the new default vector indexing strategy, `geo_shape`
queries with `relation` defined as `contains` are not yet supported. If this query relation
is an absolute necessity, it is recommended to set `strategy` to `quadtree` and use the
deprecated PrefixTree strategy indexing approach.

[[prefix-trees]]
[float]
==== Prefix trees
Expand Down