honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add data streams to flush API docs (#58950) (#58975)

This commit is contained in:
James Rodewig 2020-07-02 17:26:49 -04:00 committed by GitHub
parent e64fe15c1f
commit 84444e1a54
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/reference/indices/flush.asciidoc
View File

@ -4,7 +4,7 @@
<titleabbrev>Flush</titleabbrev> <titleabbrev>Flush</titleabbrev>
++++ ++++
Flushes one or more indices. Flushes one or more data streams or indices.
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------
@ -16,9 +16,9 @@ POST /twitter/_flush
[[flush-api-request]] [[flush-api-request]]
==== {api-request-title} ==== {api-request-title}
`POST /<index>/_flush` `POST /<target>/_flush`
`GET /<index>/_flush` `GET /<target>/_flush`
`POST /_flush` `POST /_flush`
@ -28,7 +28,7 @@ POST /twitter/_flush
[[flush-api-desc]] [[flush-api-desc]]
==== {api-description-title} ==== {api-description-title}
Flushing an index is the process of making sure that any data that is currently Flushing a data stream or index is the process of making sure that any data that is currently
only stored in the <<index-modules-translog,transaction log>> is also only stored in the <<index-modules-translog,transaction log>> is also
permanently stored in the Lucene index. When restarting, {es} replays any permanently stored in the Lucene index. When restarting, {es} replays any
unflushed operations from the transaction log into the Lucene index to bring it unflushed operations from the transaction log into the Lucene index to bring it
@ -53,11 +53,13 @@ flush API was called.
[[flush-api-path-params]] [[flush-api-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] `<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases to flush.
Wildcard expressions (`*`) are supported.
+ +
To flush all indices, To flush all data streams and indices in a cluster, omit this parameter or use
omit this parameter `_all` or `*`.
or use a value of `_all` or `*`.
[[flush-api-query-params]] [[flush-api-query-params]]
@ -112,7 +114,7 @@ Defaults to `true`.
[[flush-api-specific-ex]] [[flush-api-specific-ex]]
===== Flush a specific index ===== Flush a specific data stream or index
[source,console] [source,console]
---- ----
@ -122,7 +124,7 @@ POST /kimchy/_flush
[[flush-multi-index]] [[flush-multi-index]]
===== Flush several indices ===== Flush several data streams and indices
[source,console] [source,console]
---- ----
@ -132,7 +134,7 @@ POST /kimchy,elasticsearch/_flush
[[flush-api-all-ex]] [[flush-api-all-ex]]
===== Flush all indices ===== Flush all data streams and indices in a cluster
[source,console] [source,console]
---- ----