honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/migration/migrate_7_6.asciidoc

75 lines
2.4 KiB
Plaintext
Raw Normal View History

Add sparse vector deprecation to 7.6 migration docs. (#48435) This note was accidentally omitted from the deprecation PR.
2019-10-28 14:57:20 -04:00
[[breaking-changes-7.6]]
== Breaking changes in 7.6
++++
<titleabbrev>7.6</titleabbrev>
++++
This section discusses the changes that you need to be aware of when migrating
your application to Elasticsearch 7.6.
See also <<release-highlights>> and <<es-release-notes>>.
//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide
//tag::notable-breaking-changes[]
[DOCS] Clarifies API key breaking change (#54522)
2020-04-01 10:34:45 -04:00
[discrete]
[[breaking_76_security_changes]]
=== Security changes
[discrete]
==== {es} API key privileges
If you use an API key to create another API key (sometimes called a
_derived key_), its behavior is impacted by the fix for
https://www.elastic.co/community/security[CVE-2020-7009].
When you make a request to create API keys, you can specify an expiration and
privileges for the API key. Previously, when you created a derived key, it had
no privileges. This behavior disregarded any privileges that you specified in
the {ref}/security-api-create-api-key.html[create API key API].
As of 7.6.2, this behavior changes. To create derived keys with no privileges,
you must explicitly specify an empty role descriptor. For example:
[source,js]
----
...
"role_descriptors": {
"no-privilege": {
}
}
...
----
// NOTCONSOLE
Add sparse vector deprecation to 7.6 migration docs. (#48435) This note was accidentally omitted from the deprecation PR.
2019-10-28 14:57:20 -04:00
//end::notable-breaking-changes[]
[discrete]
[[breaking_76_search_changes]]
[DOCS] Clarifies API key breaking change (#54522)
2020-04-01 10:34:45 -04:00
=== Search changes
Add sparse vector deprecation to 7.6 migration docs. (#48435) This note was accidentally omitted from the deprecation PR.
2019-10-28 14:57:20 -04:00
[discrete]
==== Deprecation of sparse vector fields
The `sparse_vector` field type has been deprecated and will be removed in 8.0.
We have not seen much interest in this experimental field type, and don't see
a clear use case as it's currently designed. If you have feedback or
suggestions around sparse vector functionality, please let us know through
GitHub or the 'discuss' forums.
Update the signature of vector script functions. (#48653) Previously the functions accepted a doc values reference, whereas they now accept the name of the vector field. Here's an example of how a vector function was called before and after the change. ``` Before: cosineSimilarity(params.query_vector, doc['field']) After: cosineSimilarity(params.query_vector, 'field') ``` This seems more intuitive, since we don't allow direct access to vector doc values and the the meaning of `doc['field']` is unclear. The PR makes the following changes (broken into distinct commits): * Add new function signatures of the form `function(params.query_vector, 'field')` and deprecates the old ones. Because Painless doesn't allow two methods with the same name and number of arguments, we allow a generic `Object` to be passed in to the function and decide on the behavior through an `instanceof` check. * Refactor the class bindings so that the document field is passed to the constructor instead of the instance method. This allows us to avoid retrieving the vector doc values on every function invocation, which gives a tiny speed-up in benchmarks. Note that this PR adds new signatures for the sparse vector functions too, even though sparse vectors are deprecated. It seemed simplest to understand (for both us and users) to keep everything symmetric between dense and sparse vectors.
2019-10-29 18:46:05 -04:00
[discrete]
==== Update to vector function signatures
The vector functions of the form `function(query, doc['field'])` are
deprecated, and the form `function(query, 'field')` should be used instead.
For example, `cosineSimilarity(query, doc['field'])` is replaced by
Deprecate and remove camel-case nGram and edgeNGram tokenizers (#50862) (#50991) We deprecated and removed the camel-case versions of the nGram and edgeNGram filters a while ago and we should do the same with the nGram and edgeNGram tokenizers. This PR deprecates the use of these names in favour of ngram and edge_ngram in 7. Usage will be disallowed on new indices starting with 8 then.
2020-01-14 15:42:34 -05:00
`cosineSimilarity(query, 'field')`.
[discrete]
==== Disallow use of the `nGram` and `edgeNGram` tokenizer names
The `nGram` and `edgeNGram` tokenizer names haven been deprecated with 7.6.
Mappings for indices created after 7.6 will continue to work but emit a
deprecation warning. The tokenizer name should be changed to the fully
equivalent `ngram` or `edge_ngram` names for new indices and in index
templates.