Skip to content

Commit cafdc9d

Browse files
committed
[DOCS] Synchronize location of Breaking Changes (#33588)
1 parent deefaa9 commit cafdc9d

29 files changed

+184
-13
lines changed

docs/reference/index.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ include::setup/bootstrap-checks-xes.asciidoc[]
3131
:edit_url:
3232
include::upgrade.asciidoc[]
3333

34-
include::migration/index.asciidoc[]
35-
3634
include::api-conventions.asciidoc[]
3735

3836
include::docs.asciidoc[]
@@ -78,6 +76,8 @@ include::glossary.asciidoc[]
7876

7977
include::release-notes/highlights.asciidoc[]
8078

79+
include::migration/index.asciidoc[]
80+
8181
include::release-notes.asciidoc[]
8282

8383
include::redirects.asciidoc[]

docs/reference/migration/migrate_6_0.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[breaking-changes-6.0]]
22
== Breaking changes in 6.0
3+
++++
4+
<titleabbrev>6.0</titleabbrev>
5+
++++
36

47
This section discusses the changes that you need to be aware of when migrating
58
your application to Elasticsearch 6.0.

docs/reference/migration/migrate_6_0/aggregations.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_aggregations_changes]]
23
=== Aggregations changes
34

5+
[float]
46
==== Deprecated `pattern` element of include/exclude for terms aggregations has been removed
57

68
The `include` and `exclude` options of `terms` aggregations used to accept a
@@ -50,6 +52,7 @@ POST /twitter/_search?size=0
5052
// CONSOLE
5153
// TEST[setup:twitter]
5254

55+
[float]
5356
==== Numeric `to` and `from` parameters in `date_range` aggregation are interpreted according to `format` now
5457

5558
Numeric `to` and `from` parameters in `date_range` aggregations used to always be interpreted as `epoch_millis`,
@@ -58,13 +61,14 @@ Now we interpret these parameters according to the `format` of the target field.
5861
If the `format` in the mappings is not compatible with the numeric input value, a compatible
5962
`format` (e.g. `epoch_millis`, `epoch_second`) must be specified in the `date_range` aggregation, otherwise an error is thrown.
6063

61-
64+
[float]
6265
==== `global_ordinals_hash` and `global_ordinals_low_cardinality` are deprecated in the `terms` aggregation
6366

6467
The execution hints `global_ordinals_hash` and `global_ordinals_low_cardinality` are deprecated and should be replaced
6568
by `global_ordinals` which now internally choose whether it should remap global ordinals to dense ordinals or directly use the
6669
segment ordinals.
6770

71+
[float]
6872
==== `missing` is deprecated in the `composite` aggregation
6973

7074
The `missing` option of the `composite` aggregation is deprecated, `missing_bucket`

docs/reference/migration/migrate_6_0/analysis.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_analysis_changes]]
23
=== Analysis changes
34

5+
[float]
46
==== Synonym Token Filter
57

68
In 6.0, Synonym Token Filter tokenizes synonyms with whatever
@@ -11,6 +13,7 @@ and will be ignored when used in new indices. These parameters
1113
will continue to function as before when used in indices
1214
created in 5.x.
1315

16+
[float]
1417
==== Limiting the length of an analyzed text during highlighting
1518

1619
Highlighting a text that was indexed without offsets or term vectors,
@@ -20,4 +23,4 @@ To protect against this, the maximum number of characters that to be analyzed wi
2023
limited to 1000000 in the next major Elastic version. For this version, by default the limit
2124
is not set. A deprecation warning will be issued when an analyzed text exceeds 1000000.
2225
The limit can be set for a particular index with the index setting
23-
`index.highlight.max_analyzed_offset`.
26+
`index.highlight.max_analyzed_offset`.

docs/reference/migration/migrate_6_0/cat.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_cat_changes]]
23
=== Cat API changes
34

5+
[float]
46
==== Unbounded queue size in cat thread pool
57

68
Previously if a queue size backing a thread pool was unbounded, the cat thread pool API would output an empty string in

docs/reference/migration/migrate_6_0/clients.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_clients_changes]]
23
=== Clients changes
34

5+
[float]
46
==== Java High Level REST Client
57

68
Starting from version 5.6.0 a new Java client has been released: the Java High Level REST Client.

docs/reference/migration/migrate_6_0/cluster.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_cluster_changes]]
23
=== Cluster changes
34

5+
[float]
46
==== Cluster name no longer allowed in path.data
57

68
Previously the cluster name could be used in the `path.data` setting with a

docs/reference/migration/migrate_6_0/docs.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
1+
[float]
12
[[breaking_60_docs_changes]]
23
=== Document API changes
34

5+
[float]
46
==== version type `force` removed
57

68
Document modification operations may no longer specify the `version_type` of
79
`force` to override any previous version checks.
810

11+
[float]
912
==== <<upserts,Upserts>> no longer support versions
1013

1114
Adding a `version` to an upsert request is no longer supported.
1215

16+
[float]
1317
==== `created` field removed in the Index API
1418

1519
The `created` field has been removed in the Index API as in the `index` and
1620
`create` bulk operations. `operation` field should be used instead.
1721

18-
22+
[float]
1923
==== `found` field removed in the Delete API
2024

2125
The `found` field has been removed in the Delete API as in the `delete` bulk
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1+
[float]
12
[[breaking_60_geo_changes]]
23
=== Geo changes
34

5+
[float]
46
==== Deprecated `ShapeBuilders` helper class
57

68
The `ShapeBuilders` class containing static methods to create shape specific builders
79
(e.g., `ShapeBuilders.newPoint`) has been deprecated. One must now use the builder's
810
constructor instead (e.g., `new MultiPointBuilder()).
911

12+
[float]
1013
==== Deprecated `ShapeBuilder.parse` static method
1114

1215
The `ShapeBuilder.parse` method has been deprecated. Use `ShapeParser.parse` instead.

docs/reference/migration/migrate_6_0/indices.asciidoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_indices_changes]]
23
=== Indices changes
34

5+
[float]
46
==== Index templates use `index_patterns` instead of `template`
57

68
Previously templates expressed the indices that they should match using a glob
@@ -28,7 +30,7 @@ PUT _template/template_2
2830
--------------------------------------------------
2931
// CONSOLE
3032

31-
33+
[float]
3234
==== Shadow Replicas have been removed
3335

3436
Shadow replicas don't see enough usage, and have been removed. This includes the
@@ -38,42 +40,49 @@ following settings:
3840
- `index.shadow_replicas`
3941
- `node.add_lock_id_to_custom_path`
4042

43+
[float]
4144
==== Open/Close index API allows wildcard expressions that match no indices by default
4245

4346
The default value of the `allow_no_indices` option for the Open/Close index API
4447
has been changed from `false` to `true` so it is aligned with the behaviour of the
4548
Delete index API. As a result, Open/Close index API don't return an error by
4649
default when a provided wildcard expression doesn't match any closed/open index.
4750

51+
[float]
4852
==== Delete a document
4953

5054
Delete a document from non-existing index has been modified to not create the index.
5155
However if an external versioning is used the index will be created and the document
5256
will be marked for deletion.
5357

58+
[float]
5459
==== Indices aliases api resolves indices expressions only against indices
5560

5661
The index parameter in the update-aliases, put-alias, and delete-alias APIs no
5762
longer accepts alias names. Instead, it accepts only index names (or wildcards
5863
which will expand to matching indices).
5964

65+
[float]
6066
==== Delete index api resolves indices expressions only against indices
6167

6268
The index parameter in the delete index API no longer accepts alias names.
6369
Instead, it accepts only index names (or wildcards which will expand to
6470
matching indices).
6571

72+
[float]
6673
==== Support for `+` has been removed in index expressions
6774

6875
Omitting the `+` has the same effect as specifying it, hence support for `+`
6976
has been removed in index expressions.
7077

78+
[float]
7179
==== Translog retention
7280

7381
Translog files are now kept for up to 12 hours (by default), with a maximum size of `512mb` (default), and
7482
are no longer deleted on `flush`. This is to increase the chance of doing an operation based recovery when
7583
bringing up replicas up to speed.
7684

85+
[float]
7786
==== Limit to the difference between max_size and min_size in NGramTokenFilter and NGramTokenizer
7887

7988
To safeguard against creating too many index terms, the difference between
@@ -82,6 +91,7 @@ limited to 1. This default limit can be changed with the index setting
8291
index.max_ngram_diff. Note that if the limit is exceeded a deprecation
8392
warning is logged.
8493

94+
[float]
8595
==== Limit to the difference between max_size and min_size in ShingleTokenFilter
8696

8797
To safeguard against creating too many tokens, the difference between

docs/reference/migration/migrate_6_0/ingest.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
[float]
12
[[breaking_60_ingest_changes]]
23
=== Ingest changes
34

5+
[float]
46
==== Timestamp meta-data field type has changed
57

68
The type of the "timestamp" meta-data field has changed from `java.lang.String` to `java.util.Date`.
79

10+
[float]
811
==== The format of the string-formatted ingest.timestamp field has changed
912

1013
Previously, since Elasticsearch 5.4.0, you needed to use `ingest.new_date_format` to have the

docs/reference/migration/migrate_6_0/java.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
1+
[float]
12
[[breaking_60_java_changes]]
23
=== Java API changes
34

5+
[float]
46
==== `setSource` methods require XContentType
57

68
Previously the `setSource` methods and other methods that accepted byte/string representations of
79
an object source did not require the XContentType to be specified. The auto-detection of the content
810
type is no longer used, so these methods now require the XContentType as an additional argument when
911
providing the source in bytes or as a string.
1012

13+
[float]
1114
==== `DeleteByQueryRequest` requires an explicitly set query
1215

1316
In previous versions of Elasticsearch, delete by query requests without an explicit query
1417
were accepted, match_all was used as the default query and all documents were deleted
1518
as a result. From version 6.0.0, a `DeleteByQueryRequest` requires an explicit query be set.
1619

20+
[float]
1721
==== `InternalStats` and `Stats` getCountAsString() method removed
1822

1923
The `count` value in the stats aggregation represents a doc count that shouldn't require a formatted
2024
version. This method was deprecated in 5.4 in favour of just using
2125
`String.valueOf(getCount())` if needed
2226

27+
[float]
2328
==== `ActionRequestBuilder#execute` returns `ActionFuture` rather than `ListenableActionFuture`
2429

2530
When sending a request through the request builders e.g. client.prepareSearch().execute(), it used to
@@ -28,6 +33,7 @@ be possible to call `addListener` against the returned `ListenableActionFuture`.
2833
it is not possible to associate the future with listeners. The `execute` method that accept a listener
2934
as an argument can be used instead.
3035

36+
[float]
3137
==== `Terms.Order` and `Histogram.Order` classes replace by `BucketOrder`
3238

3339
The `terms`, `histogram`, and `date_histogram` aggregation code has been refactored to use common
@@ -36,17 +42,20 @@ code for ordering buckets. The `BucketOrder` class must be used instead of `Term
3642
accessing internal order instances, e.g. `BucketOrder.count(boolean)` and `BucketOrder.aggregation(String, boolean)`.
3743
Use `BucketOrder.key(boolean)` to order the `terms` aggregation buckets by `_term`.
3844

45+
[float]
3946
==== `getTookInMillis()` removed in `BulkResponse`, `SearchResponse` and `TermVectorsResponse`
4047

4148
In `BulkResponse`, `SearchResponse` and `TermVectorsResponse` `getTookInMiilis()` method
4249
has been removed in favor of `getTook` method. `getTookInMiilis()` is easily replaced by
4350
`getTook().getMillis()`.
4451

52+
[float]
4553
==== `GetField` and `SearchHitField` replaced by `DocumentField`
4654

4755
As `GetField` and `SearchHitField` have the same members, they have been unified into
4856
`DocumentField`.
4957

58+
[float]
5059
==== Some Aggregation classes have moved packages
5160

5261
The classes for the variants of the range aggregation (geo_distance, date and ip) were moved into the `org.elasticsearch.search.aggregations.bucket.range`
@@ -57,6 +66,7 @@ The `org.elasticsearch.search.aggregations.bucket.terms.support` package was rem
5766

5867
The filter aggregation classes were moved to `org.elasticsearch.search.aggregations.bucket.filter`
5968

69+
[float]
6070
==== Constructor for `PercentileRanksAggregationBuilder` has changed
6171

6272
It is now required to include the desired ranks as a non-null, non-empty array of doubles to the builder's constructor,

docs/reference/migration/migrate_6_0/mappings.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_60_mappings_changes]]
23
=== Mapping changes
34

5+
[float]
46
==== Coercion of boolean fields
57

68
Previously, Elasticsearch recognized the strings `true`, `false`, `on`, `off`, `yes`, `no`, `0`, `1` as booleans. Elasticsearch 6.0
@@ -9,6 +11,7 @@ series the previous coercion rules will continue to work on pre-6.0 indices. Thi
911
mappings immediately. However, it is not possible to create new indices from existing index templates that violate the strict `boolean`
1012
coercion rules.
1113

14+
[float]
1215
==== The `_all` meta field is now disabled by default
1316

1417
On new mappings, the `_all` meta field that contains a copy of the text from
@@ -18,18 +21,21 @@ check if `_all` is enabled/disabled and switch to executing the query across all
1821
fields if `_all` is disabled. `_all` can no longer be configured for indices
1922
created with Elasticsearch version 6.0 or later.
2023

24+
[float]
2125
==== The `include_in_all` mapping parameter is now disallowed
2226

2327
Since the ++_all++ field is now disabled by default and cannot be configured for
2428
indices created with Elasticsearch 6.0 or later, the `include_in_all` setting is
2529
now disallowed for these indices' mappings.
2630

31+
[float]
2732
==== Unrecognized `match_mapping_type` options not silently ignored
2833

2934
Previously Elasticsearch would silently ignore any dynamic templates that
3035
included a `match_mapping_type` type that was unrecognized. An exception is now
3136
thrown on an unrecognized type.
3237

38+
[float]
3339
==== Validation of `locale` on date fields
3440

3541
The `locale` option of `date` fields previously allowed almost any string values,

0 commit comments

Comments
 (0)