From 73d6522d9b2cb9e42d3fb89aa7c8f86efb3a05ce Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 9 Jun 2021 16:55:06 -0400 Subject: [PATCH 1/3] [DOCS] Deprecate `geo_bounding_box` query's `type` param The `geo_bounding_box` query's `type` parameter is currently ignored and has no effect on the query. This documents the deprecation of the parameter in 7.14.0. The parameter will be removed in 8.0.0. Relates to #70561. --- .../reference/migration/migrate_7_14.asciidoc | 32 ++++++++++++- .../query-dsl/geo-bounding-box-query.asciidoc | 46 ++----------------- 2 files changed, 34 insertions(+), 44 deletions(-) diff --git a/docs/reference/migration/migrate_7_14.asciidoc b/docs/reference/migration/migrate_7_14.asciidoc index ec023ad405695..9e12d2463503a 100644 --- a/docs/reference/migration/migrate_7_14.asciidoc +++ b/docs/reference/migration/migrate_7_14.asciidoc @@ -54,10 +54,26 @@ If a failure occurs during a rolling upgrade and older nodes cannot rejoin the cluster then you must upgrade the affected nodes. Once upgraded, they will join the cluster again. ==== +// end::notable-breaking-changes[] +[discrete] +[[deprecated-7.14]] +=== Deprecations + +The following functionality has been deprecated in {es} 7.14 and will be removed +in 8.0. While this won't have an immediate impact on your applications, we +strongly encourage you take the described steps to update your code after +upgrading to 7.14. + +NOTE: Significant changes in behavior are deprecated in a minor release and the +old behavior is supported until the next major release. To find out if you are +using any deprecated functionality, enable <>. + +// tag::notable-breaking-changes[] [discrete] [[breaking_714_core_deprecations]] -=== Core deprecations +==== Core deprecations [discrete] [[deprecate-single-data-node-watermark]] @@ -82,4 +98,18 @@ If your cluster has multiple data nodes then the has no effect and you should discontinue its use. ==== +[discrete] +[[breaking_714_search_deprecations]] +==== Search deprecations + +.The `geo_bounding_box` query's `type` parameter is deprecated. +[%collapsible] +==== +*Details* + +The `geo_bounding_box` query's `type` parameter has been deprecated in 7.14.0. +This parameter is a no-op and has no effect on the query. + +*Impact* + +Discontinue use of the `type` parameter in `geo_bounding_box` queries. +==== // end::notable-breaking-changes[] diff --git a/docs/reference/query-dsl/geo-bounding-box-query.asciidoc b/docs/reference/query-dsl/geo-bounding-box-query.asciidoc index afa1175055719..1134639c8597c 100644 --- a/docs/reference/query-dsl/geo-bounding-box-query.asciidoc +++ b/docs/reference/query-dsl/geo-bounding-box-query.asciidoc @@ -169,9 +169,9 @@ GET my_locations,my_geoshapes/_search accept geo points with invalid latitude or longitude, set to `COERCE` to also try to infer correct latitude or longitude. (default is `STRICT`). -|`type` |Set to one of `indexed` or `memory` to defines whether this filter will -be executed in memory or indexed. See <> below for further details -Default is `memory`. +|`type` | +deprecated:[7.14.0] This optional parameter is a no-op and has no effect on the +query. |======================================================================= [[query-dsl-geo-bounding-box-query-accepted-formats]] @@ -388,46 +388,6 @@ The filter can work with multiple locations / points per document. Once a single location / point matches the filter, the document will be included in the filter -[discrete] -[[geo-bbox-type]] -==== Type - -The type of the bounding box execution by default is set to `memory`, -which means in memory checks if the doc falls within the bounding box -range. In some cases, an `indexed` option will perform faster (but note -that the `geo_point` type must have lat and lon indexed in this case). -Note, when using the indexed option, multi locations per document field -are not supported. Here is an example: - -[source,console] --------------------------------------------------- -GET my_locations/_search -{ - "query": { - "bool": { - "must": { - "match_all": {} - }, - "filter": { - "geo_bounding_box": { - "pin.location": { - "top_left": { - "lat": 40.73, - "lon": -74.1 - }, - "bottom_right": { - "lat": 40.10, - "lon": -71.12 - } - }, - "type": "indexed" - } - } - } - } -} --------------------------------------------------- - [discrete] ==== Ignore Unmapped From 274eaafe9b52fca4f27a0e579c2d80702bf75e28 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 24 Jun 2021 09:19:23 -0400 Subject: [PATCH 2/3] fix merge conflict --- docs/reference/migration/migrate_7_14.asciidoc | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/docs/reference/migration/migrate_7_14.asciidoc b/docs/reference/migration/migrate_7_14.asciidoc index 088cc190e52b3..f461c8fea60fd 100644 --- a/docs/reference/migration/migrate_7_14.asciidoc +++ b/docs/reference/migration/migrate_7_14.asciidoc @@ -114,21 +114,6 @@ Discontinue use of the `type` parameter in `geo_bounding_box` queries. ==== // end::notable-breaking-changes[] -[discrete] -[[deprecated-7.14]] -=== Deprecations - -The following functionality has been deprecated in {es} 7.14 -and will be removed in 8.0. -While this won't have an immediate impact on your applications, -we strongly encourage you take the described steps to update your code -after upgrading to 7.14. - -NOTE: Significant changes in behavior are deprecated in a minor release and -the old behavior is supported until the next major release. -To find out if you are using any deprecated functionality, -enable <>. - [discrete] [[breaking_714_security_changes]] ==== Security deprecations From 56a4796b2a07ae0624cd2d89b8a811d4ea6decf8 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 24 Jun 2021 09:20:23 -0400 Subject: [PATCH 3/3] move notable changes end tag --- docs/reference/migration/migrate_7_14.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/migration/migrate_7_14.asciidoc b/docs/reference/migration/migrate_7_14.asciidoc index f461c8fea60fd..9808abe74ac98 100644 --- a/docs/reference/migration/migrate_7_14.asciidoc +++ b/docs/reference/migration/migrate_7_14.asciidoc @@ -112,7 +112,6 @@ This parameter is a no-op and has no effect on the query. *Impact* + Discontinue use of the `type` parameter in `geo_bounding_box` queries. ==== -// end::notable-breaking-changes[] [discrete] [[breaking_714_security_changes]] @@ -133,3 +132,4 @@ Configuring a realm name with a leading underscore is deprecated. In a future re it will result in an error on startup if any user configured realm has a name with a leading underscore. ==== +// end::notable-breaking-changes[]