Skip to content

Commit 3dc0911

Browse files
authored
[DOCS] Deprecate geo_bounding_box query's type param (#74008) (#74009)
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. Backport of #74008.
1 parent 7d0ef61 commit 3dc0911

File tree

2 files changed

+32
-58
lines changed

2 files changed

+32
-58
lines changed

docs/reference/migration/migrate_7_14.asciidoc

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,26 @@ If a failure occurs during a rolling upgrade and older nodes cannot rejoin the
5454
cluster then you must upgrade the affected nodes. Once upgraded, they will join
5555
the cluster again.
5656
====
57+
// end::notable-breaking-changes[]
5758

59+
[discrete]
60+
[[deprecated-7.14]]
61+
=== Deprecations
62+
63+
The following functionality has been deprecated in {es} 7.14 and will be removed
64+
in 8.0. While this won't have an immediate impact on your applications, we
65+
strongly encourage you take the described steps to update your code after
66+
upgrading to 7.14.
67+
68+
NOTE: Significant changes in behavior are deprecated in a minor release and the
69+
old behavior is supported until the next major release. To find out if you are
70+
using any deprecated functionality, enable <<deprecation-logging, deprecation
71+
logging>>.
72+
73+
// tag::notable-breaking-changes[]
5874
[discrete]
5975
[[breaking_714_core_deprecations]]
60-
=== Core deprecations
76+
==== Core deprecations
6177

6278
[discrete]
6379
[[deprecate-single-data-node-watermark]]
@@ -82,22 +98,20 @@ If your cluster has multiple data nodes then the
8298
has no effect and you should discontinue its use.
8399
====
84100

85-
// end::notable-breaking-changes[]
86-
87101
[discrete]
88-
[[deprecated-7.14]]
89-
=== Deprecations
102+
[[breaking_714_search_deprecations]]
103+
==== Search deprecations
90104

91-
The following functionality has been deprecated in {es} 7.14
92-
and will be removed in 8.0.
93-
While this won't have an immediate impact on your applications,
94-
we strongly encourage you take the described steps to update your code
95-
after upgrading to 7.14.
105+
.The `geo_bounding_box` query's `type` parameter is deprecated.
106+
[%collapsible]
107+
====
108+
*Details* +
109+
The `geo_bounding_box` query's `type` parameter has been deprecated in 7.14.0.
110+
This parameter is a no-op and has no effect on the query.
96111
97-
NOTE: Significant changes in behavior are deprecated in a minor release and
98-
the old behavior is supported until the next major release.
99-
To find out if you are using any deprecated functionality,
100-
enable <<deprecation-logging, deprecation logging>>.
112+
*Impact* +
113+
Discontinue use of the `type` parameter in `geo_bounding_box` queries.
114+
====
101115

102116
[discrete]
103117
[[breaking_714_security_changes]]
@@ -118,3 +132,4 @@ Configuring a realm name with a leading underscore is deprecated. In a future re
118132
it will result in an error on startup if any user configured realm has a name
119133
with a leading underscore.
120134
====
135+
// end::notable-breaking-changes[]

docs/reference/query-dsl/geo-bounding-box-query.asciidoc

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,9 @@ GET my_locations,my_geoshapes/_search
169169
accept geo points with invalid latitude or longitude, set to
170170
`COERCE` to also try to infer correct latitude or longitude. (default is `STRICT`).
171171

172-
|`type` |Set to one of `indexed` or `memory` to defines whether this filter will
173-
be executed in memory or indexed. See <<geo-bbox-type,Type>> below for further details
174-
Default is `memory`.
172+
|`type` |
173+
deprecated:[7.14.0] This optional parameter is a no-op and has no effect on the
174+
query.
175175
|=======================================================================
176176

177177
[[query-dsl-geo-bounding-box-query-accepted-formats]]
@@ -388,47 +388,6 @@ The filter can work with multiple locations / points per document. Once
388388
a single location / point matches the filter, the document will be
389389
included in the filter
390390

391-
[discrete]
392-
[[geo-bbox-type]]
393-
==== Type
394-
395-
The type of the bounding box execution by default is set to `memory`,
396-
which means in memory checks if the doc falls within the bounding box
397-
range. In some cases, an `indexed` option will perform faster (but note
398-
that the `geo_point` type must have lat and lon indexed in this case).
399-
Note, when using the indexed option, multi locations per document field
400-
are not supported. Here is an example:
401-
402-
[source,console]
403-
--------------------------------------------------
404-
GET my_locations/_search
405-
{
406-
"query": {
407-
"bool": {
408-
"must": {
409-
"match_all": {}
410-
},
411-
"filter": {
412-
"geo_bounding_box": {
413-
"pin.location": {
414-
"top_left": {
415-
"lat": 40.73,
416-
"lon": -74.1
417-
},
418-
"bottom_right": {
419-
"lat": 40.10,
420-
"lon": -71.12
421-
}
422-
},
423-
"type": "indexed"
424-
}
425-
}
426-
}
427-
}
428-
}
429-
--------------------------------------------------
430-
// TEST[warning:Deprecated field [type] used, this field is unused and will be removed entirely]
431-
432391
[discrete]
433392
==== Ignore Unmapped
434393

0 commit comments

Comments
 (0)