Skip to content

Commit be63930

Browse files
committed
Update the Flush API documentation (#33551)
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
1 parent d3cfa61 commit be63930

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/reference/indices/flush.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
== Flush
33

44
The flush API allows to flush one or more indices through an API. The
5-
flush process of an index basically frees memory from the index by
6-
flushing data to the index storage and clearing the internal
7-
<<index-modules-translog,transaction log>>. By
8-
default, Elasticsearch uses memory heuristics in order to automatically
9-
trigger flush operations as required in order to clear memory.
5+
flush process of an index makes sure that any data that is currently only
6+
persisted in the <<index-modules-translog,transaction log>> is also permanently
7+
persisted in Lucene. This reduces recovery times as that data doesn't need to be
8+
reindexed from the transaction logs after the Lucene indexed is opened. By
9+
default, Elasticsearch uses heuristics in order to automatically
10+
trigger flushes as required. It is rare for users to need to call the API directly.
1011

1112
[source,js]
1213
--------------------------------------------------

0 commit comments

Comments
 (0)