[DOCS] Change wildcard to index pattern in DS docs (#61058) (#61060)

This commit is contained in:
James Rodewig 2020-08-12 15:14:03 -04:00 committed by GitHub
parent c6276ae177
commit 910abeea2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 19 deletions

View File

@ -378,7 +378,7 @@ index created by the new stream.
Follow these steps: Follow these steps:
. Choose a name or wildcard (`*`) pattern for a new data stream. This new data . Choose a name or index pattern for a new data stream. This new data
stream will contain data from your existing stream. stream will contain data from your existing stream.
+ +
You can use the resolve index API to check if the name or pattern matches any You can use the resolve index API to check if the name or pattern matches any
@ -387,7 +387,7 @@ using another name or pattern.
-- --
The following resolve index API request checks for any existing indices, index The following resolve index API request checks for any existing indices, index
aliases, or data streams that start with `new-data-stream`. If not, the aliases, or data streams that start with `new-data-stream`. If not, the
`new-data-stream*` wildcard pattern can be used to create a new data stream. `new-data-stream*` index pattern can be used to create a new data stream.
[source,console] [source,console]
---- ----
@ -414,7 +414,7 @@ indices.
+ +
This index template must meet the This index template must meet the
<<create-a-data-stream-template,requirements for a data stream template>>. It <<create-a-data-stream-template,requirements for a data stream template>>. It
should also contain your previously chosen name or wildcard pattern in the should also contain your previously chosen name or index pattern in the
`index_patterns` property. `index_patterns` property.
+ +
TIP: If you are only adding or changing a few things, we recommend you create a TIP: If you are only adding or changing a few things, we recommend you create a
@ -429,7 +429,7 @@ index template, `new-data-stream-template`. `new-data-stream-template`
uses `my-data-stream-template` as its basis, with the following uses `my-data-stream-template` as its basis, with the following
changes: changes:
* The `index_patterns` wildcard pattern matches any index or data stream * The index pattern in `index_patterns` matches any index or data stream
starting with `new-data-stream`. starting with `new-data-stream`.
* The `@timestamp` field mapping uses the `date_nanos` field data type rather * The `@timestamp` field mapping uses the `date_nanos` field data type rather
than the `date` data type. than the `date` data type.
@ -463,8 +463,8 @@ PUT /_index_template/new-data-stream-template
-- --
. Use the <<indices-create-data-stream,create data stream API>> to manually . Use the <<indices-create-data-stream,create data stream API>> to manually
create the new data stream. The name of the data stream must match the name or create the new data stream. The name of the data stream must match the index
wildcard pattern defined in the new template's `index_patterns` property. pattern defined in the new template's `index_patterns` property.
+ +
We do not recommend <<index-documents-to-create-a-data-stream,indexing new data We do not recommend <<index-documents-to-create-a-data-stream,indexing new data
to create this data stream>>. Later, you will reindex older data from an to create this data stream>>. Later, you will reindex older data from an
@ -483,7 +483,7 @@ to retain such a backing index until you are ready to delete its newest data.
+ +
-- --
The following create data stream API request targets `new-data-stream`, which The following create data stream API request targets `new-data-stream`, which
matches the wildcard pattern for `new-data-stream-template`. matches the index pattern for `new-data-stream-template`.
Because no existing index or data stream uses this name, this request creates Because no existing index or data stream uses this name, this request creates
the `new-data-stream` data stream. the `new-data-stream` data stream.

View File

@ -103,7 +103,7 @@ PUT /_ilm/policy/my-data-stream-policy
A data stream uses an index template to configure its backing indices. A A data stream uses an index template to configure its backing indices. A
template for a data stream must specify: template for a data stream must specify:
* One or more wildcard (`*`) patterns that match the name of the stream. * One or more index patterns that match the name of the stream.
* The mappings and settings for the stream's backing indices. * The mappings and settings for the stream's backing indices.
@ -201,7 +201,7 @@ You can create a data stream using one of two methods:
You can automatically create a data stream using an indexing request. Submit You can automatically create a data stream using an indexing request. Submit
an <<add-documents-to-a-data-stream,indexing request>> to a target an <<add-documents-to-a-data-stream,indexing request>> to a target
matching the name or wildcard pattern defined in the template's `index_patterns` matching the index pattern defined in the template's `index_patterns`
property. property.
If the indexing request's target doesn't exist, {es} creates the data stream and If the indexing request's target doesn't exist, {es} creates the data stream and
@ -211,7 +211,7 @@ NOTE: Data streams support only specific types of indexing requests. See
<<add-documents-to-a-data-stream>>. <<add-documents-to-a-data-stream>>.
The following <<docs-index_,index API>> request targets `my-data-stream`, which The following <<docs-index_,index API>> request targets `my-data-stream`, which
matches the wildcard pattern for `my-data-stream-template`. Because matches the index pattern for `my-data-stream-template`. Because
no existing index or data stream uses this name, this request creates the no existing index or data stream uses this name, this request creates the
`my-data-stream` data stream and indexes the document to it. `my-data-stream` data stream and indexes the document to it.
@ -256,11 +256,11 @@ index of the new data stream.
==== Manually create a data stream ==== Manually create a data stream
You can use the <<indices-create-data-stream,create data stream API>> to You can use the <<indices-create-data-stream,create data stream API>> to
manually create a data stream. The name of the data stream must match the name manually create a data stream. The name of the data stream must match the index
or wildcard pattern defined in the template's `index_patterns` property. pattern defined in the template's `index_patterns` property.
The following create data stream request targets `my-data-stream-alt`, which The following create data stream request targets `my-data-stream-alt`, which
matches the wildcard pattern for `my-data-stream-template`. Because matches the index pattern for `my-data-stream-template`. Because
no existing index or data stream uses this name, this request creates the no existing index or data stream uses this name, this request creates the
`my-data-stream-alt` data stream. `my-data-stream-alt` data stream.

View File

@ -226,7 +226,7 @@ GET /my-data-stream/_search
} }
---- ----
You can use a comma-separated list or wildcard (`*`) expression to search You can use a comma-separated list to search
multiple data streams, indices, and index aliases in the same request. multiple data streams, indices, and index aliases in the same request.
The following request searches `my-data-stream` and `my-data-stream-alt`, The following request searches `my-data-stream` and `my-data-stream-alt`,
@ -243,8 +243,11 @@ GET /my-data-stream,my-data-stream-alt/_search
} }
} }
---- ----
The following request uses the `my-data-stream*` wildcard expression to search any data
stream, index, or index alias beginning with `my-data-stream`. Index patterns are also supported.
The following request uses the `my-data-stream*` index pattern to search any
data stream, index, or index alias beginning with `my-data-stream`.
[source,console] [source,console]
---- ----

View File

@ -4,8 +4,8 @@
<titleabbrev>Resolve index</titleabbrev> <titleabbrev>Resolve index</titleabbrev>
++++ ++++
Resolves the specified name(s) and/or wildcard expression(s) to indices, index Resolves the specified name(s) and/or index patterns for indices, index
aliases, and data streams. Multiple expressions and remote clusters are aliases, and data streams. Multiple patterns and remote clusters are
supported. supported.
//// ////
@ -63,7 +63,7 @@ GET /_resolve/index/my-index-*
`<name>`:: `<name>`::
+ +
-- --
(Required, string) Comma-separated name(s) or wildcard expression(s) of the (Required, string) Comma-separated name(s) or index pattern(s) of the
indices, index aliases, and data streams to resolve. Resources on indices, index aliases, and data streams to resolve. Resources on
<<modules-remote-clusters,remote clusters>> can be specified using the <<modules-remote-clusters,remote clusters>> can be specified using the
`<cluster>:<name>` syntax. `<cluster>:<name>` syntax.