github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Add require_alias to Bulk API (#66259)

Browse source
This commit is contained in:
James Rodewig 2020-12-14 10:57:17 -05:00 • committed by GitHub
parent c05c4b3d45
commit 8dc3fa98f7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/reference/docs/bulk.asciidoc
View file

@ -211,6 +211,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
`require_alias`::
(Optional, Boolean)
If `true`, the request's actions must target an <<indices-aliases,index alias>>.
Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source]
@ -237,6 +242,8 @@ The following line must contain the source data to be indexed.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
-- --
`delete`:: `delete`::
@ -249,6 +256,8 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
`_id`:: `_id`::
(Required, string) (Required, string)
The document ID. The document ID.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
-- --
`index`:: `index`::
@ -261,6 +270,8 @@ The following line must contain the source data to be indexed.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
-- --
`update`:: `update`::
@ -272,6 +283,8 @@ The following line must contain the partial document and update options.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
-- --
`doc`:: `doc`::

7
docs/reference/rest-api/common-parms.asciidoc
View file

@ -580,6 +580,13 @@ such as `1264`.
A value of `-1` indicates {es} was unable to compute this number. A value of `-1` indicates {es} was unable to compute this number.
end::memory[] end::memory[]
tag::bulk-require-alias[]
`require_alias`::
(Optional, Boolean)
If `true`, the action must target an <<indices-aliases,index alias>>. Defaults
to `false`.
end::bulk-require-alias[]
tag::require-alias[] tag::require-alias[]
`require_alias`:: `require_alias`::
(Optional, Boolean) (Optional, Boolean)