Skip to content

Commit 18efd76

Browse files
adamretterfacebook-github-bot
authored andcommittedAug 3, 2020
Add defaults to ReadOptions doc (#7215)
Summary: Very small improvements to document the defaults. Pull Request resolved: #7215 Reviewed By: zhichao-cao Differential Revision: D22902286 fbshipit-source-id: a754d172a0d8e4c03754f6f1771d4a693d60a770
1 parent d941b89 commit 18efd76

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed
 

‎include/rocksdb/options.h

+5-1
Original file line numberDiff line numberDiff line change
@@ -1283,7 +1283,8 @@ struct ReadOptions {
12831283
// block cache?
12841284
// Callers may wish to set this field to false for bulk scans.
12851285
// This would help not to the change eviction order of existing items in the
1286-
// block cache. Default: true
1286+
// block cache.
1287+
// Default: true
12871288
bool fill_cache;
12881289

12891290
// Specify to create a tailing iterator -- a special iterator that has a
@@ -1304,13 +1305,15 @@ struct ReadOptions {
13041305
// If true when calling Get(), we also skip prefix bloom when reading from
13051306
// block based table. It provides a way to read existing data after
13061307
// changing implementation of prefix extractor.
1308+
// Default: false
13071309
bool total_order_seek;
13081310

13091311
// When true, by default use total_order_seek = true, and RocksDB can
13101312
// selectively enable prefix seek mode if won't generate a different result
13111313
// from total_order_seek, based on seek key, and iterator upper bound.
13121314
// Not suppported in ROCKSDB_LITE mode, in the way that even with value true
13131315
// prefix mode is not used.
1316+
// Default: false
13141317
bool auto_prefix_mode;
13151318

13161319
// Enforce that the iterator only iterates over the same prefix as the seek.
@@ -1366,6 +1369,7 @@ struct ReadOptions {
13661369
// only the most recent version visible to timestamp is returned.
13671370
// The user-specified timestamp feature is still under active development,
13681371
// and the API is subject to change.
1372+
// Default: nullptr
13691373
const Slice* timestamp;
13701374
const Slice* iter_start_ts;
13711375

0 commit comments

Comments
 (0)
Please sign in to comment.