Update the Flush API documentation #33551
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
bleskes
added
>docs
|
Pinging @elastic/es-distributed |
jasontedor
requested changes
Sep 9, 2018
| 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 <<index-modules-translog,transaction log>> is also perminantly |
There was a problem hiding this comment.
“perminantly” -> “permanently”
| persisted in the <<index-modules-translog,transaction log>> 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 |
| 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. |
There was a problem hiding this comment.
Let’s end the sentence after “required”, drop “and”, add “It” before “is” and add “need to” between “to” and “call”. “It is rare for users to need to call the API directly.”
|
@bleskes are you still interested in merging this? |
|
@ywelsch thanks for the ping. It's on the list but keeps on being pushed down in terms of priority. I'll pick it up. |
bleskes
added a commit
that referenced
this pull request
Jan 15, 2019
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
bleskes
added a commit
that referenced
this pull request
Jan 15, 2019
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
bleskes
added a commit
that referenced
this pull request
Jan 15, 2019
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
jasontedor
added a commit
to jasontedor/elasticsearch
that referenced
this pull request
Jan 15, 2019
* elastic/master: Docs be explicit on how to turn off deprecated auditing (elastic#37316) Fix line length for monitor and remove suppressions (elastic#37456) Fix IndexShardTestCase.recoverReplica(IndexShard, IndexShard, boolean) (elastic#37414) Update the Flush API documentation (elastic#33551) [TEST] Muted testDifferentRolesMaintainPathOnRestart Remove dead code from ShardSearchStats (elastic#37421) Simplify testSendSnapshotSendsOps (elastic#37445) SQL: Fix issue with field names containing "." (elastic#37364) Restore lost @Inject annotation (elastic#37452)
bleskes
added a commit
that referenced
this pull request
Jan 23, 2019
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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