[DOCS] Tidied up the multi-indices docs
This commit is contained in:
parent
93ba3b5e70
commit
12a095d797
|
@ -26,17 +26,30 @@ support wildcards, for example: `test*`, and the ability to "add" (`+`)
|
|||
and "remove" (`-`), for example: `+test*,-test3`.
|
||||
|
||||
All multi indices API support the following url query string parameters:
|
||||
* `ignore_unavailable` - Controls whether to ignore if any specified indices are unavailable, this includes indices
|
||||
that don't exist or closed indices. Either `true` or `false` can be specified.
|
||||
* `allow_no_indices` - Controls whether to fail if a wildcard indices expressions results into no concrete indices.
|
||||
Either `true` or `false` can be specified. For example if the wildcard expression `foo*` is specified and no indices
|
||||
are available that start with `foo` then depending on this setting the request will fail. This setting is also applicable
|
||||
when `_all`, `*` or no index has been specified.
|
||||
* `expand_wildcards` - Controls to what kind of concrete indices wildcard indices expression expand to. If `open` is
|
||||
specified then the wildcard expression if expanded to only open indices and if `closed` is specified then the wildcard
|
||||
expression if expanded only to closed indices. Also both values (`open,closed`) can be specified to expand to all indices.
|
||||
|
||||
The defaults settings for the above parameters dependent on the api being used.
|
||||
`ignore_unavailable`::
|
||||
|
||||
Controls whether to ignore if any specified indices are unavailable, this
|
||||
includes indices that don't exist or closed indices. Either `true` or `false`
|
||||
can be specified.
|
||||
|
||||
`allow_no_indices`::
|
||||
|
||||
Controls whether to fail if a wildcard indices expressions results into no
|
||||
concrete indices. Either `true` or `false` can be specified. For example if
|
||||
the wildcard expression `foo*` is specified and no indices are available that
|
||||
start with `foo` then depending on this setting the request will fail. This
|
||||
setting is also applicable when `_all`, `*` or no index has been specified.
|
||||
|
||||
`expand_wildcards`::
|
||||
|
||||
Controls to what kind of concrete indices wildcard indices expression expand
|
||||
to. If `open` is specified then the wildcard expression if expanded to only
|
||||
open indices and if `closed` is specified then the wildcard expression if
|
||||
expanded only to closed indices. Also both values (`open,closed`) can be
|
||||
specified to expand to all indices.
|
||||
|
||||
The defaults settings for the above parameters depend on the api being used.
|
||||
|
||||
NOTE: Single index APIs such as the <<docs>> and the
|
||||
<<indices-aliases,single-index `alias` APIs>> do not support multiple indices.
|
||||
|
|
Loading…
Reference in New Issue