Struct Database

pub struct Database { /* private fields */ }

Implementations

impl Database

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

pub fn open_with_columns<P: AsRef<Path>>(path: P, columns: u32) -> Result<Self>

pub fn open_in_memory_with_columns<P: AsRef<Path>>( path: P, columns: u32, ) -> Result<Self>

pub fn path(&self) -> PathBuf

pub fn config(&self) -> DatabaseConfig

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 transaction(&self) -> DBTransaction

Helper to create new transaction for this database.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl KeyValueDB for Database

fn delete<'a>( &self, col: u32, key: &'a [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<DBValue>>> + Send + 'a>>

Remove a value by key, returning the old value

fn get<'a>( &self, col: u32, key: &'a [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<DBValue>>> + Send + 'a>>

Get a value by key.

fn write( &self, transaction: DBTransaction, ) -> Pin<Box<dyn Future<Output = Result<(), DBTransactionError>> + Send + 'static>>

Write a transaction of changes to the backing store.

fn iter<'a, T: 'a, F: FnMut(DBKeyValueRef<'_>) -> Result<Option<T>> + Send + Sync + 'a>( &self, col: u32, prefix: Option<&'a [u8]>, f: F, ) -> Pin<Box<dyn Future<Output = Result<Option<T>>> + Send + 'a>>

Iterate over the data for a given column. Return all key/value pairs, optionally where the key starts with the given prefix. Iterator closure returns true for more items, false to stop iteration.

fn iter_keys<'a, T: 'a, F: FnMut(DBKeyRef<'_>) -> Result<Option<T>> + Send + Sync + 'a>( &self, col: u32, prefix: Option<&'a [u8]>, f: F, ) -> Pin<Box<dyn Future<Output = Result<Option<T>>> + Send + 'a>>

Iterate over the data for a given column. Return all keys, optionally where the key starts with the given prefix. Iterator closure returns true for more items, false to stop iteration.

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

Query statistics.

fn num_columns(&self) -> Result<u32>

The number of column families in the db.

fn num_keys( &self, col: u32, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send>>

The number of keys in a column (estimated).

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

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

fn transaction(&self) -> DBTransaction

Helper to create a new transaction.

fn has_key<'a>( &self, col: u32, key: &'a [u8], ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'a>>

Check for the existence of a value by key.

fn has_prefix<'a>( &self, col: u32, prefix: &'a [u8], ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'a>>

Check for the existence of a value by prefix.

fn first_with_prefix<'a>( &self, col: u32, prefix: &'a [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<(Vec<u8>, Vec<u8>)>, Error>> + Send + 'a>>

Get the first value matching the given prefix.