Skip to content

Commit

Permalink
[DOCS] Update geo_shape breaking changes doc (#36868)
Browse files Browse the repository at this point in the history
This updates the 6.6 breaking changes doc to include changes to geo_shape as a result of switching to lucene's new LatLonShape field.
  • Loading branch information
nknize authored Dec 20, 2018
1 parent 01c1421 commit 92a11c0
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/reference/migration/migrate_6_6.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,33 @@ the cluster settings API.
- `xpack.notification.slack.account.<id>.url`, instead use
`xpack.notification.slack.account.<id>.secure_url`

[float]
=== Mappings changes

[float]
==== Changed default `geo_shape` indexing strategy

`geo_shape` types now default to using a vector indexing approach based on Lucene's new
`LatLonShape` field type. This indexes shapes as a triangular mesh instead of decomposing
them into individual grid cells. To index using legacy prefix trees the `tree` parameter
must be explicitly set to one of `quadtree` or `geohash`. Note that these strategies are
now deprecated and will be removed in a future version.

The impact of changing the default indexing strategy is as follows:

* `CONTAINS` queries are not yet supported
* `geo_shape` query does not support querying by `MULTIPOINT` type
* `LINESTRING` and `MULTILINESTRING` queries do not yet support `WITHIN` relations

*IMPORTANT NOTE*: If you are using any of the features listed above, newly created indexes
with default `geo_shape` type (e.g., templates) might no longer work. It is recommended
to update the `geo_shape` field mapping to explicitly define the `tree` parameter to one of
`geohash` or `quadtree`. This will ensure newly created indexes are feature compatible with
previously created indexes.

[float]
==== deprecated `geo_shape` parameters

The following type parameters are deprecated for the `geo_shape` field type: `tree`,
`precision`, `tree_levels`, `distance_error_pct`, `points_only`, and `strategy`. They
will be removed in a future version.

0 comments on commit 92a11c0

Please sign in to comment.