Skip to content

Edits to text in Bulk API doc #39083

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
merged 2 commits into from
Feb 20, 2019
Merged

Edits to text in Bulk API doc #39083

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bccafc4
Edits to text in Bulk API doc
dmeiss Feb 19, 2019
f6136cc
Fix in Update section
dmeiss Feb 19, 2019
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
16 changes: 8 additions & 8 deletions docs/reference/docs/bulk.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ optional_source\n
--------------------------------------------------
// NOTCONSOLE

*NOTE*: the final line of data must end with a newline character `\n`. Each newline character
*NOTE*: The final line of data must end with a newline character `\n`. Each newline character
may be preceded by a carriage return `\r`. When sending requests to this endpoint the
`Content-Type` header should be set to `application/x-ndjson`.

The possible actions are `index`, `create`, `delete` and `update`.
The possible actions are `index`, `create`, `delete`, and `update`.
`index` and `create` expect a source on the next
line, and have the same semantics as the `op_type` parameter to the
standard index API (i.e. create will fail if a document with the same
Expand Down Expand Up @@ -215,7 +215,7 @@ documents. See <<optimistic-concurrency-control>> for more details.
Each bulk item can include the version value using the
`version` field. It automatically follows the behavior of the
index / delete operation based on the `_version` mapping. It also
support the `version_type` (see <<index-versioning, versioning>>)
support the `version_type` (see <<index-versioning, versioning>>).

[float]
[[bulk-routing]]
Expand Down Expand Up @@ -246,20 +246,20 @@ NOTE: Only the shards that receive the bulk request will be affected by
`refresh`. Imagine a `_bulk?refresh=wait_for` request with three
documents in it that happen to be routed to different shards in an index
with five shards. The request will only wait for those three shards to
refresh. The other two shards of that make up the index do not
refresh. The other two shards that make up the index do not
participate in the `_bulk` request at all.

[float]
[[bulk-update]]
=== Update

When using `update` action `retry_on_conflict` can be used as field in
When using the `update` action, `retry_on_conflict` can be used as a field in
Copy link
Contributor Author

@dmeiss dmeiss Feb 19, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this fixes it -- does it look OK to you?

Copy link
Member

@danielmitterdorfer danielmitterdorfer Feb 19, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me, yes. Thank you.

the action itself (not in the extra payload line), to specify how many
times an update should be retried in the case of a version conflict.

The `update` action payload, supports the following options: `doc`
The `update` action payload supports the following options: `doc`
(partial document), `upsert`, `doc_as_upsert`, `script`, `params` (for
script), `lang` (for script) and `_source`. See update documentation for details on
script), `lang` (for script), and `_source`. See update documentation for details on
the options. Example with update actions:

[source,js]
Expand All @@ -283,4 +283,4 @@ POST _bulk
[[bulk-security]]
=== Security

See <<url-access-control>>
See <<url-access-control>>.