From 84444e1a545243ad6952c8e297de93018a65c8ca Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 2 Jul 2020 17:26:49 -0400 Subject: [PATCH] [DOCS] Add data streams to flush API docs (#58950) (#58975) --- docs/reference/indices/flush.asciidoc | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 4916e70d758..050653d1e6e 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -4,7 +4,7 @@ Flush ++++ -Flushes one or more indices. +Flushes one or more data streams or indices. [source,console] -------------------------------------------------- @@ -16,9 +16,9 @@ POST /twitter/_flush [[flush-api-request]] ==== {api-request-title} -`POST //_flush` +`POST //_flush` -`GET //_flush` +`GET //_flush` `POST /_flush` @@ -28,7 +28,7 @@ POST /twitter/_flush [[flush-api-desc]] ==== {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 <> is also permanently stored in the Lucene index. When restarting, {es} replays any 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]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] +``:: +(Optional, string) +Comma-separated list of data streams, indices, and index aliases to flush. +Wildcard expressions (`*`) are supported. + -To flush all indices, -omit this parameter -or use a value of `_all` or `*`. +To flush all data streams and indices in a cluster, omit this parameter or use +`_all` or `*`. [[flush-api-query-params]] @@ -112,7 +114,7 @@ Defaults to `true`. [[flush-api-specific-ex]] -===== Flush a specific index +===== Flush a specific data stream or index [source,console] ---- @@ -122,7 +124,7 @@ POST /kimchy/_flush [[flush-multi-index]] -===== Flush several indices +===== Flush several data streams and indices [source,console] ---- @@ -132,7 +134,7 @@ POST /kimchy,elasticsearch/_flush [[flush-api-all-ex]] -===== Flush all indices +===== Flush all data streams and indices in a cluster [source,console] ----