Skip to content

Commit 5c25cbd

Browse files
authored
[DOCS] Add admon for legacy prefix tree mapping params (#76582) (#77372)
If you specify a deprecated mapping parameter related to prefix trees, a `geo_shape` field will use prefix tree encoding. This adds a related admon to the top of the geoshape field docs page. This admon will help users avoid accidentally switching from the default BKD tree encoding. Closes #40266.
1 parent 8f0c563 commit 5c25cbd

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,23 @@ contain shapes other than just points.
1212
You can query documents using this type using
1313
<<query-dsl-geo-shape-query,geo_shape Query>>.
1414

15+
[IMPORTANT]
16+
====
17+
{es} encodes `geo_shape` values as <<geoshape-indexing-approach,BKD trees>> by
18+
default. To use BKD encoding, do not specify the following
19+
<<geo-shape-mapping-options,mapping options>>:
20+
21+
* `distance_error_pct`
22+
* `points_only`
23+
* `precision`
24+
* `strategy`
25+
* `tree_levels`
26+
* `tree`
27+
28+
If you specify one or more of these options, the field will use prefix tree
29+
encoding instead. Prefix tree encoding is deprecated.
30+
====
31+
1532
[[geo-shape-mapping-options]]
1633
[discrete]
1734
==== Mapping Options

0 commit comments

Comments
 (0)