Class 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/
rocksdb+file:///var/data/planet/?secure=true (trie keys are hashed)

The following query string parameters are supported:

`block-cache`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `blockCacheSize` parameter. 512 by default.
`tx-cache`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `txCacheSize` parameter. 1024 by default.
`max-total-wal-size`	Corresponds to RocksDB's `max_total_wal_size` option.
`keep-log-file-num`	Corresponds to RocksDB's `keep_log_file_num` option.
`max_log_file_size`	Corresponds to RocksDB's `max_log_file_size` option.
`tx-epoch-unit-secs`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `txEpochUnitSeconds` parameter. 86400 by default.
`block-epoch-unit-secs`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `blockEpochUnitSeconds` parameter. 86400 by default.
`connection-cache`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `dbConnectionCacheSize` parameter. 100 by default.
`states-dir`	Corresponds to RocksDBKeyValueStore(String)'s `path` parameter. It is relative to the URI path, and defaults to `states`.
`secure`	true or false (default). Corresponds to TrieStateStore(IKeyValueStore, Boolean)'s `secure` parameter.

Inheritance

Object

RocksDBKeyValueStore

Implements

IKeyValueStore

IDisposable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Libplanet.RocksDBStore

Assembly: Libplanet.RocksDBStore.dll

Syntax

public class RocksDBKeyValueStore : IKeyValueStore, IDisposable

Constructors

| Improve this Doc View Source

RocksDBKeyValueStore(String)

Creates a new RocksDBKeyValueStore.

Declaration

public RocksDBKeyValueStore(string path)

Parameters

Type	Name	Description
String	path	The path of the storage file will be saved.

Methods

| Improve this Doc View Source

Delete(in KeyBytes)

Deletes the given key. If the key does not exist, nothing happens.

Declaration

public void Delete(in KeyBytes key)

Parameters

Type	Name	Description
KeyBytes	key	A key to delete.

| Improve this Doc View Source

Delete(IEnumerable<KeyBytes>)

Delete multiple keys at once.

Declaration

public void Delete(IEnumerable<KeyBytes> keys)

Parameters

Type	Name	Description
IEnumerable<KeyBytes>	keys	Keys to delete. The order of keys does not matter. Non-existent keys are ignored.

| Improve this Doc View Source

Dispose()

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/
rocksdb+file:///var/data/planet/?secure=true (trie keys are hashed)

The following query string parameters are supported:

`block-cache`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `blockCacheSize` parameter. 512 by default.
`tx-cache`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `txCacheSize` parameter. 1024 by default.
`max-total-wal-size`	Corresponds to RocksDB's `max_total_wal_size` option.
`keep-log-file-num`	Corresponds to RocksDB's `keep_log_file_num` option.
`max_log_file_size`	Corresponds to RocksDB's `max_log_file_size` option.
`tx-epoch-unit-secs`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `txEpochUnitSeconds` parameter. 86400 by default.
`block-epoch-unit-secs`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `blockEpochUnitSeconds` parameter. 86400 by default.
`connection-cache`	Corresponds to RocksDBStore(String, Int32, Int32, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, Int32, Int32, Int32)'s `dbConnectionCacheSize` parameter. 100 by default.
`states-dir`	Corresponds to RocksDBKeyValueStore(String)'s `path` parameter. It is relative to the URI path, and defaults to `states`.
`secure`	true or false (default). Corresponds to TrieStateStore(IKeyValueStore, Boolean)'s `secure` parameter.

Declaration

public void Dispose()

| Improve this Doc View Source

Exists(in KeyBytes)

Checks whether the given key exists in the store.

Declaration

public bool Exists(in KeyBytes key)

Parameters

Type	Name	Description
KeyBytes	key	A key to check.

Returns

Type	Description
Boolean	true if the key exists; otherwise, false.

| Improve this Doc View Source

Get(in KeyBytes)

Gets the value associated with the specified key.

Declaration

public byte[] Get(in KeyBytes key)

Parameters

Type	Name	Description
KeyBytes	key	The key whose value to get.

Returns

Type	Description
Byte[]	The value associated with the specified key.

Exceptions

Type	Condition
KeyNotFoundException	Thrown when the key is not found.

| Improve this Doc View Source

Get(IEnumerable<KeyBytes>)

Gets multiple values associated with the specified keys at once.

Declaration

public IReadOnlyDictionary<KeyBytes, byte[]> Get(IEnumerable<KeyBytes> keys)

Parameters

Type	Name	Description
IEnumerable<KeyBytes>	keys	Keys whose values to get. The order of keys does not matter. Duplicate keys after their first occurrence are ignored.

Returns

Type	Description
IReadOnlyDictionary<KeyBytes, Byte[]>	Values associated the specified `keys`. Non-existent `keys` are omitted (rather than being filled with null).

| Improve this Doc View Source

ListKeys()

Lists all keys that have been stored in the storage.

Declaration

public IEnumerable<KeyBytes> ListKeys()

Returns

Type	Description
IEnumerable<KeyBytes>	All keys in an arbitrary order. The order might be vary for each call.

| Improve this Doc View Source

Set(in KeyBytes, Byte[])

Sets the value to the key. If the key already exists, the value is overwritten.

Declaration

public void Set(in KeyBytes key, byte[] value)

Parameters

Type	Name	Description
KeyBytes	key	The key of the value to set.
Byte[]	value	The value to set.

| Improve this Doc View Source

Set(IDictionary<KeyBytes, Byte[]>)

Sets all values in the given dictionary.

Declaration

public void Set(IDictionary<KeyBytes, byte[]> values)

Parameters

Type	Name	Description
IDictionary<KeyBytes, Byte[]>	values	A values to set.

Implements

IKeyValueStore

System.IDisposable