Skip to content

Commit 66b02a8

Browse files
Update api-conventions.md (elastic#130371)
1 parent 5cd17a9 commit 66b02a8

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

docs/reference/elasticsearch/rest-apis/api-conventions.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,39 @@ GET /_nodes/ra*:2
421421
GET /_nodes/ra*:2*
422422
```
423423

424+
### Component Selectors [api-component-selectors]
425+
426+
A data stream component is a logical grouping of indices that help organize data inside a data stream. All data streams contain a `data` component by default. The `data` component comprises the data stream's backing indices. When searching, managing, or indexing into a data stream, the `data` component is what you are interacting with by default.
427+
428+
Some data stream features are exposed as additional components alongside its `data` component. These other components are comprised of separate sets of backing indices. These additional components store supplemental data independent of the data stream's regular backing indices. An example of another component is the `failures` component exposed by the data stream [failure store](docs-content://manage-data/data-store/data-streams/failure-store.md) feature, which captures documents that fail to be ingested in a separate set of backing indices on the data stream.
429+
430+
Some APIs that accept a `<data-stream>`, `<index>`, or `<target>` request path parameter also support *selector syntax* which defines which component on a data stream the API should operate on. To use a selector, it is appended to the index or data stream name. Selectors can be combined with other index pattern syntax like [date math](#api-date-math-index-names) and wildcards.
431+
432+
There are currently two selector suffixes supported by {{es}} APIs:
433+
434+
`::data`
435+
: Refers to a data stream's backing indices containing regular data. Data streams always contain a data component.
436+
437+
`::failures`
438+
: This component refers to the internal indices used for a data stream's [failure store](docs-content://manage-data/data-store/data-streams/failure-store.md).
439+
440+
As an example, [search]({{es-apis}}group/endpoint-search), [field capabilities]({{es-apis}}operation/operation-field-caps), and [index stats]({{es-apis}}operation/operation-indices-stats) APIs can all report results from a different component rather than from the default data.
441+
442+
```console
443+
# Search a data stream normally
444+
GET my-data-stream/_search
445+
# Search a data stream's failure data if present
446+
GET my-data-stream::failures/_search
447+
448+
# Syntax can be combined with other index pattern syntax (wildcards, multi-target, date math, cross cluster search, etc)
449+
GET logs-*::failures/_search
450+
GET logs-*::data,logs-*::failures/_count
451+
GET remote-cluster:logs-*-*::failures/_search
452+
GET *::data,*::failures,-logs-rdbms-*::failures/_stats
453+
GET <logs-{now/d}>::failures/_search
454+
```
455+
456+
424457
## Parameters [api-conventions-parameters]
425458

426459
Rest parameters (when using HTTP, map to HTTP URL parameters) follow the convention of using underscore casing.
@@ -583,4 +616,3 @@ If one of these quantities is large we’ll print it out like 10m for 10,000,000
583616

584617
`p`
585618
: Peta
586-

0 commit comments

Comments
 (0)