Deprecate `nGram` and `edgeNGram` names for ngram filters by cbuescher · Pull Request #30209 · elastic/elasticsearch

cbuescher · 2018-04-27T16:04:07Z

The camel case name nGram should be removed in favour of ngram and
similar for edgeNGram and edge_ngram. Before removal, we need to
deprecate the camel case names first. This change adds deprecation
warnings for indices with versions 6.4.0 and higher and logs deprecation
warnings.

elasticmachine · 2018-04-27T16:04:09Z

Pinging @elastic/es-search-aggs

cbuescher · 2018-04-27T16:05:24Z

This is quiet similar to #27429, so maybe @jpountz would be a good person to review this since we already had a longer discussion on that topic.

) The camel case name `nGram` should be removed in favour of `ngram` and similar for `edgeNGram` and `edge_ngram`. Before removal, we need to deprecate the camel case names first. This change adds deprecation warnings for indices with versions 6.4.0 and higher and logs deprecation warnings.

jimczi

LGTM

jimczi · 2018-05-16T13:27:25Z

...es/analysis-common/src/main/java/org/elasticsearch/analysis/common/CommonAnalysisPlugin.java

-                new EdgeNGramTokenFilter(input, EdgeNGramTokenFilter.DEFAULT_MIN_GRAM_SIZE, EdgeNGramTokenFilter.DEFAULT_MAX_GRAM_SIZE)));
+        filters.add(PreConfiguredTokenFilter.singletonWithVersion("edgeNGram", false, (reader, version) -> {
+            if (version.onOrAfter(org.elasticsearch.Version.V_6_4_0)) {
+                DEPRECATION_LOGGER.deprecatedAndMaybeLog("esgeNGram_deprecation",


nit: s/esgeNgram/edgeNgram/

cbuescher · 2018-05-16T13:50:02Z

@jimczi thanks, will merge as soon as CI passes again.

cbuescher · 2018-05-16T15:50:48Z

test this please

cbuescher · 2018-05-16T20:28:41Z

@elasticmachine test this please

The camel case name `nGram` should be removed in favour of `ngram` and similar for `edgeNGram` and `edge_ngram`. Before removal, we need to deprecate the camel case names first. This change adds deprecation warnings for indices with versions 6.4.0 and higher and logs deprecation warnings.

…ngs-to-true * elastic/master: (25 commits) [DOCS] Replace X-Pack terms with attributes [ML] Clean left behind model state docs (elastic#30659) Correct typos filters agg docs duplicated 'bucket' word removal (elastic#30677) top_hits doc example description update (elastic#30676) [Docs] Replace InetSocketTransportAddress with TransportAdress (elastic#30673) [TEST] Account for increase in ML C++ memory usage (elastic#30675) User proper write-once semantics for GCS repository (elastic#30438) Remove bogus file accidentally added Add detailed assert message to IndexAuditUpgradeIT (elastic#30669) Adjust fast forward for token expiration test (elastic#30668) Improve explanation in rescore (elastic#30629) Deprecate `nGram` and `edgeNGram` names for ngram filters (elastic#30209) Watcher: Fix watch history template for dynamic slack attachments (elastic#30172) Fix _cluster/state to always return cluster_uuid (elastic#30656) [Tests] Add debug information to CorruptedFileIT Preserve REST client auth despite 401 response (elastic#30558) [test] packaging: add windows boxes (elastic#30402) Make xpack modules instead of a meta plugin (elastic#30589) Mute ShrinkIndexIT ...

* 6.x: Mute testCorruptFileThenSnapshotAndRestore Plugins: Remove meta plugins (#30670) Upgrade to Lucene-7.4.0-snapshot-59f2b7aec2 (#30726) Docs: Add uptasticsearch to list of clients (#30738) [TEST] Reduce forecast overflow to disk test memory limit (#30727) [DOCS] Removes redundant index.asciidoc files (#30707) [DOCS] Moves X-Pack configurationg pages in table of contents (#30702) [ML][TEST] Fix bucket count assertion in ModelPlotsIT (#30717) [ML][TEST] Make AutodetectMemoryLimitIT less fragile (#30716) [Build] Add test admin when starting gradle run with trial license and [ML] provide tmp storage for forecasting and possibly any ml native jobs #30399 Tests: Fail if test watches could not be triggered (#30392) Watcher: Prevent duplicate watch triggering during upgrade (#30643) [ML] add version information in case of crash of native ML process (#30674) Add detailed assert message to IndexAuditUpgradeIT (#30669) Preserve REST client auth despite 401 response (#30558) Make TransportClusterStateAction abide to our style (#30697) [DOCS] Fixes edit URLs for stack overview (#30583) [DOCS] Add missing callout in IndicesClientDocumentationIT Backport get settings API changes to 6.x (#30494) Silence sleep based watcher test [DOCS] Replace X-Pack terms with attributes Improve explanation in rescore (#30629) [test] packaging: add windows boxes (#30402) [ML] Clean left behind model state docs (#30659) filters agg docs duplicated 'bucket' word removal (#30677) top_hits doc example description update (#30676) MovingFunction Pipeline agg backport to 6.x (#30658) [Docs] Replace InetSocketTransportAddress with TransportAdress (#30673) [TEST] Account for increase in ML C++ memory usage (#30675) User proper write-once semantics for GCS repository (#30438) Deprecate `nGram` and `edgeNGram` names for ngram filters (#30209) Watcher: Fix watch history template for dynamic slack attachments (#30172) Fix _cluster/state to always return cluster_uuid (#30656)

* master: Scripting: Remove getDate methods from ScriptDocValues (#30690) Upgrade to Lucene-7.4.0-snapshot-59f2b7aec2 (#30726) [Docs] Fix single page :docs:check invocation (#30725) Docs: Add uptasticsearch to list of clients (#30738) [DOCS] Removes out-dated x-pack/docs/en/index.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) [TEST] Reduce forecast overflow to disk test memory limit (#30727) Plugins: Remove meta plugins (#30670) [DOCS] Moves X-Pack configurationg pages in table of contents (#30702) TEST: Add engine log to testCorruptFileThenSnapshotAndRestore [ML][TEST] Fix bucket count assertion in ModelPlotsIT (#30717) [ML][TEST] Make AutodetectMemoryLimitIT less fragile (#30716) Default copy settings to true and deprecate on the REST layer (#30598) [Build] Add test admin when starting gradle run with trial license and This implementation lazily (on 1st forecast request) checks for available diskspace and creates a subfolder for storing data outside of Lucene indexes, but as part of the ES data paths. Tests: Fail if test watches could not be triggered (#30392) [ML] add version information in case of crash of native ML process (#30674) Make TransportClusterStateAction abide to our style (#30697) Change required version for Get Settings transport API changes to 6.4.0 (#30706) [DOCS] Fixes edit URLs for stack overview (#30583) Silence sleep based watcher test [TEST] Adjust version skips for movavg/movfn tests [DOCS] Replace X-Pack terms with attributes [ML] Clean left behind model state docs (#30659) Correct typos filters agg docs duplicated 'bucket' word removal (#30677) top_hits doc example description update (#30676) [Docs] Replace InetSocketTransportAddress with TransportAdress (#30673) [TEST] Account for increase in ML C++ memory usage (#30675) User proper write-once semantics for GCS repository (#30438) Remove bogus file accidentally added Add detailed assert message to IndexAuditUpgradeIT (#30669) Adjust fast forward for token expiration test (#30668) Improve explanation in rescore (#30629) Deprecate `nGram` and `edgeNGram` names for ngram filters (#30209) Watcher: Fix watch history template for dynamic slack attachments (#30172) Fix _cluster/state to always return cluster_uuid (#30656) [Tests] Add debug information to CorruptedFileIT # Conflicts: # test/framework/src/main/java/org/elasticsearch/indices/analysis/AnalysisFactoryTestCase.java

) The camel case name `nGram` should be removed in favour of `ngram` and similar for `edgeNGram` and `edge_ngram`. Before removal, we need to deprecate the camel case names first. This change adds deprecation warnings for indices with versions 6.4.0 and higher and logs deprecation warnings.

In #30209 we deprecated the camel case `nGram` filter name in favour of `ngram` and did the same for `edgeNGram` and `edge_ngram`. Using these names has been deprecated since 6.4 and is issuing deprecation warnings since then. I think we can remove these filters in 8.0. In a backport of this PR I would change what was a dreprecation warning from 6.4. to an error starting with new indices created in 7.0.

In elastic#30209 we deprecated the camel case `nGram` filter name in favour of `ngram` and did the same for `edgeNGram` and `edge_ngram`. Using these names has been deprecated since 6.4 and is issuing deprecation warnings since then. I think we can remove these filters in 8.0. In a backport of this PR I would change what was a dreprecation warning from 6.4. to an error starting with new indices created in 7.0.

In #30209 we deprecated the camel case `nGram` filter name in favour of `ngram` and did the same for `edgeNGram` and `edge_ngram` and we are removing those names in 8.0. This change disallows using the deprecated names for new indices created in 7.0 by throwing an error if these filters are used. Relates to #38911

cbuescher added review :Search Relevance/Analysis How text is split into tokens >deprecation v7.0.0 v6.4.0 labels Apr 27, 2018

cbuescher requested a review from jpountz April 27, 2018 16:05

cbuescher force-pushed the deprecate-nGram-edgeNGram branch from 18696dc to babcb71 Compare May 2, 2018 10:29

cbuescher changed the title ~~Deprecate nGram and edgeNGram names for ngram filters (#27429)~~ Deprecate nGram and edgeNGram names for ngram filters May 2, 2018

cbuescher force-pushed the deprecate-nGram-edgeNGram branch from babcb71 to e808530 Compare May 3, 2018 14:16

Christoph Büscher added 2 commits May 15, 2018 15:43

Merge branch 'master' into deprecate-nGram-edgeNGram

875ad00

Renamed test class

0de4aac

jimczi approved these changes May 16, 2018

View reviewed changes

jimczi mentioned this pull request May 16, 2018

edge_ngram is now edgeNGram? #30653

Closed

corrected typo

b836759

Merge branch 'master' into deprecate-nGram-edgeNGram

6db2205

Merge branch 'master' into deprecate-nGram-edgeNGram

a89b604

cbuescher merged commit b634065 into elastic:master May 17, 2018

cbuescher mentioned this pull request May 23, 2018

Deprecate word_delimiter in favour of word_delimiter_graph #29216

Closed

Mpdreamz mentioned this pull request Sep 20, 2018

[meta] 6.4.0 release elastic/elasticsearch-net#3397

Closed

89 tasks

jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

cbuescher mentioned this pull request Feb 14, 2019

Remove nGram and edgeNGram token filter names #38911

Merged

cbuescher mentioned this pull request Feb 18, 2019

Remove nGram and edgeNGram token filter names (#38911) #39070

Merged

cbuescher mentioned this pull request Dec 20, 2019

Throw Error on deprecated nGram and edgeNGram custom filters #50376

Merged

cbuescher deleted the deprecate-nGram-edgeNGram branch November 27, 2025 10:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `nGram` and `edgeNGram` names for ngram filters#30209

Deprecate `nGram` and `edgeNGram` names for ngram filters#30209
cbuescher merged 6 commits intoelastic:masterfrom
cbuescher:deprecate-nGram-edgeNGram

cbuescher commented Apr 27, 2018

Uh oh!

elasticmachine commented Apr 27, 2018

Uh oh!

cbuescher commented Apr 27, 2018

Uh oh!

jimczi left a comment

Uh oh!

jimczi May 16, 2018

Uh oh!

cbuescher commented May 16, 2018

Uh oh!

cbuescher commented May 16, 2018

Uh oh!

cbuescher commented May 16, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

cbuescher commented Apr 27, 2018

Uh oh!

elasticmachine commented Apr 27, 2018

Uh oh!

cbuescher commented Apr 27, 2018

Uh oh!

jimczi left a comment

Choose a reason for hiding this comment

Uh oh!

jimczi May 16, 2018

Choose a reason for hiding this comment

Uh oh!

cbuescher commented May 16, 2018

Uh oh!

cbuescher commented May 16, 2018

Uh oh!

cbuescher commented May 16, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants