Skip to content

Commit 603cdf4

Browse files
authored
Update geo_shape docs to include unsupported features (#38138)
There are a two major features that are not yet supported by BKD Backed geo_shape: MultiPoint queries, and CONTAINS relation. It is important we are explicitly clear in the documentation that using the new approach may not work for users that depend on these features. This commit adds an IMPORTANT NOTE section to geo_shape docs that explicitly highlights these missing features and what should be done if they are an absolute necessity.
1 parent 1fa413a commit 603cdf4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/reference/mapping/types/geo-shape.asciidoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ type.
2121
|=======================================================================
2222
|Option |Description| Default
2323

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

130+
*IMPORTANT NOTES*
131+
132+
The following features are not yet supported with the new indexing approach:
133+
134+
* `geo_shape` query with `MultiPoint` geometry types - Elasticsearch currently prevents searching
135+
geo_shape fields with a MultiPoint geometry type to avoid a brute force linear search
136+
over each individual point. For now, if this is absolutely needed, this can be achieved
137+
using a `bool` query with each individual point.
138+
139+
* `CONTAINS` relation query - when using the new default vector indexing strategy, `geo_shape`
140+
queries with `relation` defined as `contains` are not yet supported. If this query relation
141+
is an absolute necessity, it is recommended to set `strategy` to `quadtree` and use the
142+
deprecated PrefixTree strategy indexing approach.
143+
130144
[[prefix-trees]]
131145
[float]
132146
==== Prefix trees

0 commit comments

Comments
 (0)