Rephrase the commentary

facebook · Feb 4, 2025 · 0d476d1 · 0d476d1
1 parent 544e6b3
commit 0d476d1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/include/rocksdb/options.h b/include/rocksdb/options.h
@@ -1948,14 +1948,14 @@ struct ReadOptions {
 
   // EXPERIMENTAL
   //
-  // When enabled, the iterator will opportunistically check whether its current
-  // superversion number matches most recent CF counterpart during Seek(),
-  // Next() and Prev() calls. If not, it will refresh itself to the latest CF
-  // superversion preserving the very same snapshot it's been assigned to for
-  // consistency. This allows the iterator to adapt to updates such as new
-  // memtables, compactions and flushes.
-  //
-  // Note: This option requires iterator to have allow_refresh_ set to `true`.
+  // Long-running iterators are holding onto memory and storage resources long
+  // after they are obsolete. This setting (when enabled) will fix that problem
+  // as long as iterators periodically make some progress. The feature is
+  // engineered so that the performance impact should be negligible. We expect
+  // the default value to be true some time in the future.
+  //
+  // Note: Does not have effect on TransactionDB with WRITE_PREPARED or
+  //       WRITE_UNPREPARED policies.
   //
   // Default: false
   bool auto_refresh_iterator_enabled = false;

diff --git a/unreleased_history/new_features/auto_refresh_iterator.md b/unreleased_history/new_features/auto_refresh_iterator.md
@@ -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.
+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.
Original file line number	Diff line number	Diff line change
		@@ -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.
		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.