[DOCS] Add data streams to bulk, delete, and index API docs #58340
Conversation
Updates existing docs for the bulk, delete and index APIs to make them aware of data streams.
jrodewig
added
:Data Management/Data streams
docs/reference/docs/bulk.asciidoc
Outdated
| Name of the index associated with the operation. If the operation targeted a | ||
| data stream, this is the associated backing index. |
There was a problem hiding this comment.
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.
Good point. I used this wording here and a modified version for failed operations.
docs/reference/docs/delete.asciidoc
Outdated
| @@ -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.
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.
:doh: Thanks for catching this. I think I got overzealous.
Fixed up here: https://github.com/elastic/elasticsearch/pull/58340/files#diff-907ef82eb2dfb22151e4312359f5aee4
Updates existing docs for the bulk, delete and index APIs to make them
aware of data streams.