Struct kvdb_rocksdb::Database

pub struct Database { /* private fields */ }

Key-Value database.

Implementations

impl Database

pub fn open<P: AsRef<Path>>(config: &DatabaseConfig, path: P) -> Result<Database>

Open database file.

Safety

The number of config.columns must not be zero.

pub fn transaction(&self) -> DBTransaction

Helper to create new transaction for this database.

pub fn write(&self, tr: DBTransaction) -> Result<()>

Commit transaction to database.

pub fn get(&self, col: u32, key: &[u8]) -> Result<Option<DBValue>>

Get value by key.

pub fn get_by_prefix(&self, col: u32, prefix: &[u8]) -> Option<Box<[u8]>>

Get value by partial key. Prefix size should match configured prefix size.

pub fn iter<'a>(
    &'a self,
    col: u32
) -> impl Iterator<Item = (Box<[u8]>, Box<[u8]>)> + 'a

Iterator over the data in the given database column index. Will hold a lock until the iterator is dropped preventing the database from being closed.

pub fn restore<P: AsRef<Path>>(&self, new_db: P) -> Result<()>

Restore the database from a copy at given path.

pub fn num_columns(&self) -> u32

The number of column families in the db.

pub fn num_keys(&self, col: u32) -> Result<u64>

The number of keys in a column (estimated).

pub fn remove_last_column(&self) -> Result<()>

Remove the last column family in the database. The deletion is definitive.

pub fn add_column(&self) -> Result<()>

Add a new column family to the DB.

pub fn get_statistics(&self) -> HashMap<String, RocksDbStatsValue>

Get RocksDB statistics.

pub fn try_catch_up_with_primary(&self) -> Result<()>

Try to catch up a secondary instance with the primary by reading as much from the logs as possible.

Guaranteed to have changes up to the the time that try_catch_up_with_primary is called if it finishes succesfully.

Blocks until the MANIFEST file and any state changes in the corresponding Write-Ahead-Logs are applied to the secondary instance. If the manifest files are very large this method could take a long time.

If Write-Ahead-Logs have been purged by the primary instance before the secondary is able to open them, the secondary will not be caught up until this function is called again and new Write-Ahead-Logs are identified.

If called while the primary is writing, the catch-up may fail.

If the secondary is unable to catch up because of missing logs, this method fails silently and no error is returned.

Calling this as primary will return an error.

Trait Implementations

impl KeyValueDB for Database

fn get(&self, col: u32, key: &[u8]) -> Result<Option<DBValue>>

Get a value by key.

fn get_by_prefix(&self, col: u32, prefix: &[u8]) -> Option<Box<[u8]>>

Get the first value matching the given prefix.

fn write(&self, transaction: DBTransaction) -> Result<()>

Write a transaction of changes to the backing store.

fn iter<'a>(
    &'a self,
    col: u32
) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + 'a>

Iterate over the data for a given column.

fn iter_with_prefix<'a>(
    &'a self,
    col: u32,
    prefix: &'a [u8]
) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + 'a>

Iterate over the data for a given column, returning all key/value pairs where the key starts with the given prefix.

fn restore(&self, new_db: &str) -> Result<()>

Attempt to replace this database with a new one located at the given path.

fn io_stats(&self, kind: IoStatsKind) -> IoStats

Query statistics.

fn transaction(&self) -> DBTransaction

Helper to create a new transaction.

fn has_key(&self, col: u32, key: &[u8]) -> Result<bool, Error>

Check for the existence of a value by key.

fn has_prefix(&self, col: u32, prefix: &[u8]) -> bool

Check for the existence of a value by prefix.

impl MallocSizeOf for Database

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself. If T::size_of is a constant, consider implementing constant_size as well.

fn constant_size() -> Option<usize>where
    Self: Sized,

Used to optimize MallocSizeOf implementation for collections like Vec and HashMap to avoid iterating over them unnecessarily. The Self: Sized bound is for object safety.