Skip to content

[7.x] Deprecate search:includeFrozen parameter (#114578) #114733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kibanamachine merged 1 commit into from
Oct 13, 2021
Merged

[7.x] Deprecate search:includeFrozen parameter (#114578) #114733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/management/advanced-options.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ because requests can be spread across all shard copies. However, results might
be inconsistent because different shards might be in different refresh states.

[[search-includefrozen]]`search:includeFrozen`::
**This setting is deprecated and will not be supported as of 9.0.**
Includes {ref}/frozen-indices.html[frozen indices] in results. Searching through
frozen indices might increase the search time. This setting is off by default.
Users must opt-in to include frozen indices.
Expand Down
6 changes: 6 additions & 0 deletions src/plugins/data/server/ui_settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,12 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
target="_blank" rel="noopener">frozen indices</a> in results if enabled. Searching through frozen indices
might increase the search time.`,
value: false,
deprecation: {
message: i18n.translate('data.advancedSettings.search.includeFrozenTextDeprecation', {
defaultMessage: 'This setting is deprecated and will be removed in Kibana 9.0.',
}),
docLinksKey: 'kibanaSearchSettings',
},
category: ['search'],
schema: schema.boolean(),
},
Expand Down