Skip to content

Commit 0d476d1

Browse files
committed
Rephrase the commentary
1 parent 544e6b3 commit 0d476d1

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

include/rocksdb/options.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1948,14 +1948,14 @@ struct ReadOptions {
19481948

19491949
// EXPERIMENTAL
19501950
//
1951-
// When enabled, the iterator will opportunistically check whether its current
1952-
// superversion number matches most recent CF counterpart during Seek(),
1953-
// Next() and Prev() calls. If not, it will refresh itself to the latest CF
1954-
// superversion preserving the very same snapshot it's been assigned to for
1955-
// consistency. This allows the iterator to adapt to updates such as new
1956-
// memtables, compactions and flushes.
1957-
//
1958-
// Note: This option requires iterator to have allow_refresh_ set to `true`.
1951+
// Long-running iterators are holding onto memory and storage resources long
1952+
// after they are obsolete. This setting (when enabled) will fix that problem
1953+
// as long as iterators periodically make some progress. The feature is
1954+
// engineered so that the performance impact should be negligible. We expect
1955+
// the default value to be true some time in the future.
1956+
//
1957+
// Note: Does not have effect on TransactionDB with WRITE_PREPARED or
1958+
// WRITE_UNPREPARED policies.
19591959
//
19601960
// Default: false
19611961
bool auto_refresh_iterator_enabled = false;
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Introduced new `auto_refresh_iterator_enabled` opt-in knob in `ReadOptions` that (when enabled) will instruct the iterator to automatically refresh itself to the latest superversion simultaneously preserving its' original snapshot for consistency.
1+
Introduced new `auto_refresh_iterator_enabled` opt-in knob in `ReadOptions` that (when enabled) will release obsolete memory and storage resources for as long as the iterator is periodically making progress.

0 commit comments

Comments
 (0)