Namespace Libplanet.RocksDBStore

Classes

RocksDBKeyValueStore

The RocksDB IKeyValueStore implementation. This stores data in the RocksDB.

RocksDBStore and RocksDBKeyValueStore-backed can be instantiated from a URI with rocksdb+file: scheme using , e.g.:

  • rocksdb+file:///var/data/planet/
  • rocksdb+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

block-cacheCorresponds to 's blockCacheSize parameter. 512 by default.
tx-cacheCorresponds to 's txCacheSize parameter. 1024 by default.
max-total-wal-sizeCorresponds to RocksDB's max_total_wal_size option.
keep-log-file-numCorresponds to RocksDB's keep_log_file_num option.
max_log_file_sizeCorresponds to RocksDB's max_log_file_size option.
tx-epoch-unit-secsCorresponds to 's txEpochUnitSeconds parameter. 86400 by default.
block-epoch-unit-secsCorresponds to 's blockEpochUnitSeconds parameter. 86400 by default.
connection-cacheCorresponds to 's dbConnectionCacheSize parameter. 100 by default.
states-dirCorresponds to 's path parameter. It is relative to the URI path, and defaults to states.

RocksDBStore

The RocksDB IStore implementation, which is more production-ready than DefaultStore. This stores data in the RocksDB with multiple partitions under the hood.

RocksDBStore and RocksDBKeyValueStore-backed TrieStateStore can be instantiated from a URI with rocksdb+file: scheme using , e.g.:

  • rocksdb+file:///var/data/planet/
  • rocksdb+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

block-cacheCorresponds to 's blockCacheSize parameter. 512 by default.
tx-cacheCorresponds to 's txCacheSize parameter. 1024 by default.
max-total-wal-sizeCorresponds to RocksDB's max_total_wal_size option.
keep-log-file-numCorresponds to RocksDB's keep_log_file_num option.
max_log_file_sizeCorresponds to RocksDB's max_log_file_size option.
tx-epoch-unit-secsCorresponds to 's txEpochUnitSeconds parameter. 86400 by default.
block-epoch-unit-secsCorresponds to 's blockEpochUnitSeconds parameter. 86400 by default.
connection-cacheCorresponds to 's dbConnectionCacheSize parameter. 100 by default.
states-dirCorresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Enums

RocksDBInstanceType

Represent 's instance type. can be instantiated as primary, read-only, or secondary. Please refer a RocksDB's document for more details.