-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Add data streams to bulk, delete, and index API docs #58340
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.
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
Changes from 1 commit
eb111b1
f3648db
14eb42b
fd99f3b
7abd9a0
f5e4960
e1e3d5a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,18 +4,19 @@ | |
<titleabbrev>Delete</titleabbrev> | ||
++++ | ||
|
||
Removes a JSON document from the specified index. | ||
Removes a JSON document from a specified data stream or index. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We disallow deletes directly on a data stream because it would require searching every backing index for the specified ID. If a document is to be deleted from a data stream, the relevant backing index must be targeted directly. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. :doh: Thanks for catching this. I think I got overzealous. Fixed up here: https://github.com/elastic/elasticsearch/pull/58340/files#diff-907ef82eb2dfb22151e4312359f5aee4 |
||
|
||
[[docs-delete-api-request]] | ||
==== {api-request-title} | ||
|
||
`DELETE /<index>/_doc/<_id>` | ||
`DELETE /<target>/_doc/<_id>` | ||
|
||
[[docs-delete-api-desc]] | ||
==== {api-description-title} | ||
|
||
You use DELETE to remove a document from an index. You must specify the | ||
index name and document ID. | ||
You can use the delete API to remove a document from a data stream or index. You | ||
must specify the document ID and the name of the data stream or index containing | ||
the document. | ||
|
||
[float] | ||
[[optimistic-concurrency-control-delete]] | ||
|
@@ -132,8 +133,9 @@ DELETE /twitter/_doc/1?timeout=5m | |
[[docs-delete-api-path-params]] | ||
==== {api-path-parms-title} | ||
|
||
`<index>`:: | ||
(Required, string) Name of the target index. | ||
`<target>`:: | ||
(Required, string) Name of data stream or index containing the document to | ||
delete. | ||
|
||
`<_id>`:: | ||
(Required, string) Unique identifier for the document. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor: I wonder if it would be more clear to say something along the lines of "the backing index into which the document was written" instead of "associated backing index" since a data stream may have many associated backing indices.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I used this wording here and a modified version for failed operations.