From c9c15c1124c0ea19f7ecb1e41635a4f17a13ff8a Mon Sep 17 00:00:00 2001 From: Boaz Leskes Date: Sun, 9 Sep 2018 14:00:27 -0500 Subject: [PATCH 1/2] Update the Flush API documentation The semantics of the API changed considerably since the documentation was written. The main change is to remove references to memory reduction (this is related to refresh). Instead, flush refers to recovery times. I also removed the references to trimming the translog as the translog may be required for other purposes (operation history for ops based recovery and complement ongoing file based recoveries). Closes #32869 --- docs/reference/indices/flush.asciidoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index db1f7c2fe00a9..a77b02275cc9b 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -2,11 +2,12 @@ == Flush The flush API allows to flush one or more indices through an API. The -flush process of an index basically frees memory from the index by -flushing data to the index storage and clearing the internal -<>. By -default, Elasticsearch uses memory heuristics in order to automatically -trigger flush operations as required in order to clear memory. +flush process of an index makes sure that any data that is currently only +persisted in the <> is also perminantly +persisted in Lucene. This reduces recovery times as that data doesn't need to be +reindexed from the transaction logs after the Lucene indexed is opened. By +default, Elasticsearch use heuristics in order to automatically +trigger flushes as required and is rare for users to call the API directly. [source,js] -------------------------------------------------- From f76649ab09931d510a8b6ca47444425004f606f5 Mon Sep 17 00:00:00 2001 From: Boaz Leskes Date: Fri, 11 Jan 2019 07:16:51 -0800 Subject: [PATCH 2/2] feedback --- docs/reference/indices/flush.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index a77b02275cc9b..72657525f9481 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -3,11 +3,11 @@ The flush API allows to flush one or more indices through an API. The flush process of an index makes sure that any data that is currently only -persisted in the <> is also perminantly +persisted in the <> is also permanently persisted in Lucene. This reduces recovery times as that data doesn't need to be reindexed from the transaction logs after the Lucene indexed is opened. By -default, Elasticsearch use heuristics in order to automatically -trigger flushes as required and is rare for users to call the API directly. +default, Elasticsearch uses heuristics in order to automatically +trigger flushes as required. It is rare for users to need to call the API directly. [source,js] --------------------------------------------------