Skip to content

[DOCS] Deprecate geo_bounding_box query's type param (#74009) #74009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 24, 2021
Merged

[DOCS] Deprecate geo_bounding_box query's type param (#74009) #74009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73d6522
[DOCS] Deprecate `geo_bounding_box` query's `type` param
jrodewig Jun 9, 2021
f521ca6
Merge remote-tracking branch 'upstream/7.x' into docs__deprecate-geo-…
jrodewig Jun 24, 2021
274eaaf
fix merge conflict
jrodewig Jun 24, 2021
56a4796
move notable changes end tag
jrodewig Jun 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 29 additions & 14 deletions docs/reference/migration/migrate_7_14.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<deprecation-logging, deprecation
logging>>.

// tag::notable-breaking-changes[]
[discrete]
[[breaking_714_core_deprecations]]
=== Core deprecations
==== Core deprecations

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

// end::notable-breaking-changes[]

[discrete]
[[deprecated-7.14]]
=== Deprecations
[[breaking_714_search_deprecations]]
==== Search 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.
.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.

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 <<deprecation-logging, deprecation logging>>.
*Impact* +
Discontinue use of the `type` parameter in `geo_bounding_box` queries.
====

[discrete]
[[breaking_714_security_changes]]
Expand All @@ -118,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[]
47 changes: 3 additions & 44 deletions docs/reference/query-dsl/geo-bounding-box-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<geo-bbox-type,Type>> 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]]
Expand Down Expand Up @@ -388,47 +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"
}
}
}
}
}
--------------------------------------------------
// TEST[warning:Deprecated field [type] used, this field is unused and will be removed entirely]

[discrete]
==== Ignore Unmapped

Expand Down