Add docs for courier:batchSearches UI setting (#46053)

* Add docs for courier:batchSearches UI setting

* Update ui_setting_defaults.js

* Update ui_setting_defaults.js

* Update advanced-options.asciidoc

* Update advanced-options.asciidoc

* Update ui_setting_defaults.js

* Update advanced-options.asciidoc

* Update ui_setting_defaults.js
This commit is contained in:
Lukas Olson 2019-09-25 17:35:44 -07:00 committed by GitHub
parent e7a0acc750
commit bfb0df92ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 2 deletions

View file

@ -185,6 +185,9 @@ Refresh the page to apply the changes.
=== Search settings
[horizontal]
`courier:batchSearches`:: When disabled, dashboard panels will load individually, and search requests will terminate when
users navigate away or update the query. When enabled, dashboard panels will load together when all of the data is loaded,
and searches will not terminate.
`courier:customRequestPreference`:: {ref}/search-request-body.html#request-body-search-preference[Request preference]
to use when `courier:setRequestPreference` is set to "custom".
`courier:ignoreFilterIfFieldNotInIndex`:: Skips filters that apply to fields that don't exist in the index for a visualization.

View file

@ -426,8 +426,9 @@ export function getUiSettingDefaults() {
type: 'boolean',
description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', {
defaultMessage:
'Batch multiple concurrent searches in a single request. This may improve overall load' +
'times, but it also means that no single search request will be returned until the last has completed.',
`When disabled, dashboard panels will load individually, and search requests will terminate when users navigate
away or update the query. When enabled, dashboard panels will load together when all of the data is loaded, and
searches will not terminate.`,
}),
category: ['search'],
},