Module properties

Properties

Full list of valid properties and descriptions pulled from here.

Structs

PropName

A borrowed name of a RocksDB property.

PropertyName

An owned name of a RocksDB property.

Constants

ACTUAL_DELAYED_WRITE_RATE

“rocksdb.actual-delayed-write-rate” - returns the current actual delayed write rate. 0 means no delay.

AGGREGATED_TABLE_PROPERTIES

“rocksdb.aggregated-table-properties” - returns a string representation of the aggregated table properties of the target column family.

BACKGROUND_ERRORS

“rocksdb.background-errors” - returns accumulated number of background errors.

BASE_LEVEL

“rocksdb.base-level” - returns number of level to which L0 data will be compacted.

BLOCK_CACHE_CAPACITY

“rocksdb.block-cache-capacity” - returns block cache capacity.

BLOCK_CACHE_PINNED_USAGE

“rocksdb.block-cache-pinned-usage” - returns the memory size for the entries being pinned.

BLOCK_CACHE_USAGE

“rocksdb.block-cache-usage” - returns the memory size for the entries residing in block cache.

CFSTATS

“rocksdb.cfstats” - Both of “rocksdb.cfstats-no-file-histogram” and “rocksdb.cf-file-histogram” together. See below for description of the two.

CFSTATS_NO_FILE_HISTOGRAM

“rocksdb.cfstats-no-file-histogram” - returns a multi-line string with general column family stats per-level over db’s lifetime (“L<n>”), aggregated over db’s lifetime (“Sum”), and aggregated over the interval since the last retrieval (“Int”). It could also be used to return the stats in the format of the map. In this case there will a pair of string to array of double for each level as well as for “Sum”. “Int” stats will not be affected when this form of stats are retrieved.

CF_FILE_HISTOGRAM

“rocksdb.cf-file-histogram” - print out how many file reads to every level, as well as the histogram of latency of single requests.

COMPACTION_PENDING

“rocksdb.compaction-pending” - returns 1 if at least one compaction is pending; otherwise, returns 0.

CURRENT_SUPER_VERSION_NUMBER

“rocksdb.current-super-version-number” - returns number of current LSM version. It is a uint64_t integer number, incremented after there is any change to the LSM tree. The number is not preserved after restarting the DB. After DB restart, it will start from 0 again.

CUR_SIZE_ACTIVE_MEM_TABLE

“rocksdb.cur-size-active-mem-table” - returns approximate size of active memtable (bytes).

CUR_SIZE_ALL_MEM_TABLES

“rocksdb.cur-size-all-mem-tables” - returns approximate size of active and unflushed immutable memtables (bytes).

DBSTATS

“rocksdb.dbstats” - returns a multi-line string with general database stats, both cumulative (over the db’s lifetime) and interval (since the last retrieval of kDBStats).

ESTIMATE_LIVE_DATA_SIZE

“rocksdb.estimate-live-data-size” - returns an estimate of the amount of live data in bytes.

ESTIMATE_NUM_KEYS

“rocksdb.estimate-num-keys” - returns estimated number of total keys in the active and unflushed immutable memtables and storage.

ESTIMATE_OLDEST_KEY_TIME

“rocksdb.estimate-oldest-key-time” - returns an estimation of oldest key timestamp in the DB. Currently only available for FIFO compaction with compaction_options_fifo.allow_compaction = false.

ESTIMATE_PENDING_COMPACTION_BYTES

“rocksdb.estimate-pending-compaction-bytes” - returns estimated total number of bytes compaction needs to rewrite to get all levels down to under target size. Not valid for other compactions than level- based.

ESTIMATE_TABLE_READERS_MEM

“rocksdb.estimate-table-readers-mem” - returns estimated memory used for reading SST tables, excluding memory used in block cache (e.g., filter and index blocks).

IS_FILE_DELETIONS_ENABLED

“rocksdb.is-file-deletions-enabled” - returns 0 if deletion of obsolete files is enabled; otherwise, returns a non-zero number.

IS_WRITE_STOPPED

“rocksdb.is-write-stopped” - Return 1 if write has been stopped.

LEVELSTATS

“rocksdb.levelstats” - returns multi-line string containing the number of files per level and total size of each level (MB).

LIVE_SST_FILES_SIZE

“rocksdb.live-sst-files-size” - returns total size (bytes) of all SST files belong to the latest LSM tree.

MEM_TABLE_FLUSH_PENDING

“rocksdb.mem-table-flush-pending” - returns 1 if a memtable flush is pending; otherwise, returns 0.

MIN_LOG_NUMBER_TO_KEEP

“rocksdb.min-log-number-to-keep” - return the minimum log number of the log files that should be kept.

MIN_OBSOLETE_SST_NUMBER_TO_KEEP

“rocksdb.min-obsolete-sst-number-to-keep” - return the minimum file number for an obsolete SST to be kept. The max value of uint64_t will be returned if all obsolete files can be deleted.

NUM_DELETES_ACTIVE_MEM_TABLE

“rocksdb.num-deletes-active-mem-table” - returns total number of delete entries in the active memtable.

NUM_DELETES_IMM_MEM_TABLES

“rocksdb.num-deletes-imm-mem-tables” - returns total number of delete entries in the unflushed immutable memtables.

NUM_ENTRIES_ACTIVE_MEM_TABLE

“rocksdb.num-entries-active-mem-table” - returns total number of entries in the active memtable.

NUM_ENTRIES_IMM_MEM_TABLES

“rocksdb.num-entries-imm-mem-tables” - returns total number of entries in the unflushed immutable memtables.

NUM_IMMUTABLE_MEM_TABLE

“rocksdb.num-immutable-mem-table” - returns number of immutable memtables that have not yet been flushed.

NUM_IMMUTABLE_MEM_TABLE_FLUSHED

“rocksdb.num-immutable-mem-table-flushed” - returns number of immutable memtables that have already been flushed.

NUM_LIVE_VERSIONS

“rocksdb.num-live-versions” - returns number of live versions. Version is an internal data structure. See version_set.h for details. More live versions often mean more SST files are held from being deleted, by iterators or unfinished compactions.

NUM_RUNNING_COMPACTIONS

“rocksdb.num-running-compactions” - returns the number of currently running compactions.

NUM_RUNNING_FLUSHES

“rocksdb.num-running-flushes” - returns the number of currently running flushes.

NUM_SNAPSHOTS

“rocksdb.num-snapshots” - returns number of unreleased snapshots of the database.

OLDEST_SNAPSHOT_TIME

“rocksdb.oldest-snapshot-time” - returns number representing unix timestamp of oldest unreleased snapshot.

OPTIONS_STATISTICS

“rocksdb.options-statistics” - returns multi-line string of options.statistics

SIZE_ALL_MEM_TABLES

“rocksdb.size-all-mem-tables” - returns approximate size of active, unflushed immutable, and pinned immutable memtables (bytes).

SSTABLES

“rocksdb.sstables” - returns a multi-line string summarizing current SST files.

STATS

“rocksdb.stats” - returns a multi-line string containing the data described by kCFStats followed by the data described by kDBStats.

TOTAL_SST_FILES_SIZE

“rocksdb.total-sst-files-size” - returns total size (bytes) of all SST files. WARNING: may slow down online queries if there are too many files.

Functions

aggregated_table_properties_at_level

“rocksdb.aggregated-table-properties-at-level<N>”, same as the previous one but only returns the aggregated table properties of the specified level “N” at the target column family.

compression_ratio_at_level

“rocksdb.compression-ratio-at-level<N>” - returns string containing the compression ratio of data at level <N>, where <N> is an ASCII representation of a level number (e.g., “0”). Here, compression ratio is defined as uncompressed data size / compressed file size. Returns “-1.0” if no open files at level <N>.

num_files_at_level

“rocksdb.num-files-at-level<N>” - returns string containing the number of files at level <N>, where <N> is an ASCII representation of a level number (e.g., “0”).