Skip to content

Commit c0a005d

Browse files
committed
Update docstring
1 parent 9891cca commit c0a005d

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

src/db_options.rs

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5068,10 +5068,18 @@ impl CompactOptions {
50685068
}
50695069
}
50705070

5071-
/// If set to < 0 or > 1, RocksDB leaves blob_garbage_collection_age_cutoff
5072-
/// from ColumnFamilyOptions in effect. Otherwise, it will override the
5073-
/// user-provided setting. This enables customers to selectively override the
5074-
/// age cutoff.
5071+
/// Override `CompactRangeOptions::blob_garbage_collection_age_cutoff` for a
5072+
/// single manual compaction.
5073+
///
5074+
/// If set to `< 0` or `> 1`, RocksDB leaves the
5075+
/// `blob_garbage_collection_age_cutoff` from `ColumnFamilyOptions` in
5076+
/// effect (this is the default, `-1`). Otherwise, it overrides the
5077+
/// user-provided setting for the duration of this compaction. This
5078+
/// enables callers to selectively override the age cutoff per
5079+
/// `compact_range` call.
5080+
///
5081+
/// See [`Options::set_blob_gc_age_cutoff`] for the CF-level setter that
5082+
/// this value overrides.
50755083
pub fn set_blob_garbage_collection_age_cutoff(&mut self, v: c_double) {
50765084
unsafe {
50775085
ffi::rocksdb_compactoptions_set_blob_garbage_collection_age_cutoff(self.inner, v);

0 commit comments

Comments
 (0)