Skip to content

Commit

Permalink
[DOCS] Synchronize location of Breaking Changes (#33588)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Sep 27, 2018
1 parent deefaa9 commit cafdc9d
Show file tree
Hide file tree
Showing 29 changed files with 184 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/reference/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ include::setup/bootstrap-checks-xes.asciidoc[]
:edit_url:
include::upgrade.asciidoc[]

include::migration/index.asciidoc[]

include::api-conventions.asciidoc[]

include::docs.asciidoc[]
Expand Down Expand Up @@ -78,6 +76,8 @@ include::glossary.asciidoc[]

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

include::migration/index.asciidoc[]

include::release-notes.asciidoc[]

include::redirects.asciidoc[]
3 changes: 3 additions & 0 deletions docs/reference/migration/migrate_6_0.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[breaking-changes-6.0]]
== Breaking changes in 6.0
++++
<titleabbrev>6.0</titleabbrev>
++++

This section discusses the changes that you need to be aware of when migrating
your application to Elasticsearch 6.0.
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/migration/migrate_6_0/aggregations.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_aggregations_changes]]
=== Aggregations changes

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

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

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

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


[float]
==== `global_ordinals_hash` and `global_ordinals_low_cardinality` are deprecated in the `terms` aggregation

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

[float]
==== `missing` is deprecated in the `composite` aggregation

The `missing` option of the `composite` aggregation is deprecated, `missing_bucket`
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/migration/migrate_6_0/analysis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_analysis_changes]]
=== Analysis changes

[float]
==== Synonym Token Filter

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

[float]
==== Limiting the length of an analyzed text during highlighting

Highlighting a text that was indexed without offsets or term vectors,
Expand All @@ -20,4 +23,4 @@ To protect against this, the maximum number of characters that to be analyzed wi
limited to 1000000 in the next major Elastic version. For this version, by default the limit
is not set. A deprecation warning will be issued when an analyzed text exceeds 1000000.
The limit can be set for a particular index with the index setting
`index.highlight.max_analyzed_offset`.
`index.highlight.max_analyzed_offset`.
2 changes: 2 additions & 0 deletions docs/reference/migration/migrate_6_0/cat.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_cat_changes]]
=== Cat API changes

[float]
==== Unbounded queue size in cat thread pool

Previously if a queue size backing a thread pool was unbounded, the cat thread pool API would output an empty string in
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/migration/migrate_6_0/clients.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_clients_changes]]
=== Clients changes

[float]
==== Java High Level REST Client

Starting from version 5.6.0 a new Java client has been released: the Java High Level REST Client.
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/migration/migrate_6_0/cluster.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_cluster_changes]]
=== Cluster changes

[float]
==== Cluster name no longer allowed in path.data

Previously the cluster name could be used in the `path.data` setting with a
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/migration/migrate_6_0/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
[float]
[[breaking_60_docs_changes]]
=== Document API changes

[float]
==== version type `force` removed

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

[float]
==== <<upserts,Upserts>> no longer support versions

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

[float]
==== `created` field removed in the Index API

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


[float]
==== `found` field removed in the Delete API

The `found` field has been removed in the Delete API as in the `delete` bulk
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/migration/migrate_6_0/geo.asciidoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
[float]
[[breaking_60_geo_changes]]
=== Geo changes

[float]
==== Deprecated `ShapeBuilders` helper class

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

[float]
==== Deprecated `ShapeBuilder.parse` static method

The `ShapeBuilder.parse` method has been deprecated. Use `ShapeParser.parse` instead.
12 changes: 11 additions & 1 deletion docs/reference/migration/migrate_6_0/indices.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_indices_changes]]
=== Indices changes

[float]
==== Index templates use `index_patterns` instead of `template`

Previously templates expressed the indices that they should match using a glob
Expand Down Expand Up @@ -28,7 +30,7 @@ PUT _template/template_2
--------------------------------------------------
// CONSOLE


[float]
==== Shadow Replicas have been removed

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

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

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

[float]
==== Delete a document

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

[float]
==== Indices aliases api resolves indices expressions only against indices

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

[float]
==== Delete index api resolves indices expressions only against indices

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

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

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

[float]
==== Translog retention

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

[float]
==== Limit to the difference between max_size and min_size in NGramTokenFilter and NGramTokenizer

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

[float]
==== Limit to the difference between max_size and min_size in ShingleTokenFilter

To safeguard against creating too many tokens, the difference between
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/migration/migrate_6_0/ingest.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
[float]
[[breaking_60_ingest_changes]]
=== Ingest changes

[float]
==== Timestamp meta-data field type has changed

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

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

Previously, since Elasticsearch 5.4.0, you needed to use `ingest.new_date_format` to have the
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/migration/migrate_6_0/java.asciidoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
[float]
[[breaking_60_java_changes]]
=== Java API changes

[float]
==== `setSource` methods require XContentType

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

[float]
==== `DeleteByQueryRequest` requires an explicitly set query

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

[float]
==== `InternalStats` and `Stats` getCountAsString() method removed

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

[float]
==== `ActionRequestBuilder#execute` returns `ActionFuture` rather than `ListenableActionFuture`

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

[float]
==== `Terms.Order` and `Histogram.Order` classes replace by `BucketOrder`

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

[float]
==== `getTookInMillis()` removed in `BulkResponse`, `SearchResponse` and `TermVectorsResponse`

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

[float]
==== `GetField` and `SearchHitField` replaced by `DocumentField`

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

[float]
==== Some Aggregation classes have moved packages

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

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

[float]
==== Constructor for `PercentileRanksAggregationBuilder` has changed

It is now required to include the desired ranks as a non-null, non-empty array of doubles to the builder's constructor,
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/migration/migrate_6_0/mappings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[float]
[[breaking_60_mappings_changes]]
=== Mapping changes

[float]
==== Coercion of boolean fields

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

[float]
==== The `_all` meta field is now disabled by default

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

[float]
==== The `include_in_all` mapping parameter is now disallowed

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

[float]
==== Unrecognized `match_mapping_type` options not silently ignored

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

[float]
==== Validation of `locale` on date fields

The `locale` option of `date` fields previously allowed almost any string values,
Expand Down
Loading

0 comments on commit cafdc9d

Please sign in to comment.