Skip to content

Commit

Permalink
Update docs for v8.13.0 release (#106684)
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticsearchmachine committed Mar 25, 2024
1 parent f7c86bb commit 4e6e1e5
Show file tree
Hide file tree
Showing 3 changed files with 556 additions and 1 deletion.
116 changes: 115 additions & 1 deletion docs/reference/migration/migrate_8_13.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,119 @@ coming::[8.13.0]
[[breaking-changes-8.13]]
=== Breaking changes

There are no breaking changes in {es} 8.13.
The following changes in {es} 8.13 might affect your applications
and prevent them from operating normally.
Before upgrading to 8.13, review these changes and take the described steps
to mitigate the impact.


There are no notable breaking changes in {es} 8.13.
But there are some less critical breaking changes.

[discrete]
[[breaking_813_index_setting_changes]]
==== Index setting changes

[[change_index_look_ahead_time_index_settings_default_value_from_2_hours_to_30_minutes]]
.Change `index.look_ahead_time` index setting's default value from 2 hours to 30 minutes.
[%collapsible]
====
*Details* +
Lower the `index.look_ahead_time` index setting's max value from 2 hours to 30 minutes.
*Impact* +
Documents with @timestamp of 30 minutes or more in the future will be rejected. Before documents with @timestamp of 2 hours or more in the future were rejected. If the previous behaviour should be kept, then update the `index.look_ahead_time` setting to two hours before performing the upgrade.
====

[[lower_look_ahead_time_index_settings_max_value]]
.Lower the `look_ahead_time` index setting's max value
[%collapsible]
====
*Details* +
Lower the `look_ahead_time` index setting's max value from 7 days to 2 hours.
*Impact* +
Any value between 2 hours and 7 days will be as a look ahead time of 2 hours is defined
====

[discrete]
[[breaking_813_rest_api_changes]]
==== REST API changes

[[esql_grammar_from_metadata_no_longer_requires]]
.ESQL: Grammar - FROM METADATA no longer requires []
[%collapsible]
====
*Details* +
Remove [ ] for METADATA option inside FROM command statements
*Impact* +
Previously to return metadata fields, one had to use square brackets: (eg. 'FROM index [METADATA _index]'). This is no longer needed: the [ ] are dropped and do not have to be specified, thus simplifying the command above to:'FROM index METADATA _index'.
====

[[es_ql_remove_project_keyword_from_grammar]]
.ES|QL: remove PROJECT keyword from the grammar
[%collapsible]
====
*Details* +
Removes the PROJECT keyword (an alias for KEEP) from ES|QL grammar
*Impact* +
Before this change, users could use PROJECT as an alias for KEEP in ESQL queries, (eg. 'FROM idx | PROJECT name, surname') the parser replaced PROJECT with KEEP, emitted a warning: 'PROJECT command is no longer supported, please use KEEP instead' and the query was executed normally. With this change, PROJECT command is no longer recognized by the query parser; queries using PROJECT command now return a parsing exception.
====

[[esql_remove_nan_finite_infinite]]
.[ESQL] Remove is_nan, is_finite, and `is_infinite`
[%collapsible]
====
*Details* +
Removes the functions `is_nan`, `is_finite`, and `is_infinite`.
*Impact* +
Attempting to use the above functions will now be a planner time error. These functions are no longer supported.
====


[discrete]
[[deprecated-8.13]]
=== Deprecations

The following functionality has been deprecated in {es} 8.13
and will be removed in a future version.
While this won't have an immediate impact on your applications,
we strongly encourage you to take the described steps to update your code
after upgrading to 8.13.

To find out if you are using any deprecated functionality,
enable <<deprecation-logging, deprecation logging>>.

[discrete]
[[deprecations_813_cluster_and_node_setting]]
==== Cluster and node setting deprecations

[[deprecate_client_type]]
.Deprecate `client.type`
[%collapsible]
====
*Details* +
The node setting `client.type` has been ignored since the node client was removed in 8.0. The setting is now deprecated and will be removed in a future release.
*Impact* +
Remove the `client.type` setting from `elasticsearch.yml`
====

[discrete]
[[deprecations_813_rest_api]]
==== REST API deprecations

[[desirednode_deprecate_node_version_field_make_it_optional_for_current_version]]
.`DesiredNode:` deprecate `node_version` field and make it optional for the current version
[%collapsible]
====
*Details* +
The desired_node API includes a `node_version` field to perform validation on the new node version required. This kind of check is too broad, and it's better done by external logic, so it has been removed, making the `node_version` field not necessary. The field will be removed in a later version.
*Impact* +
Users should update their usages of `desired_node` to not include the `node_version` field anymore.
====

0 comments on commit 4e6e1e5

Please sign in to comment.