Struct Database 

pub struct Database { /* private fields */ }

Implementations

impl Database

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

pub fn path(&self) -> PathBuf

pub fn config(&self) -> DatabaseConfig

pub fn columns(&self) -> u32

pub fn control_table(&self) -> Arc<DatabaseTable>

pub fn column_table(&self, col: u32) -> Arc<DatabaseTable>

pub fn conn_blocking<T, F>(&self, func: F) -> Result<T, Error>

where F: FnOnce(&Connection) -> Result<T, Error> + Send + 'static, T: Send + 'static,

pub async fn conn<T, F>(&self, func: F) -> Result<T, Error>

where F: FnOnce(&Connection) -> Result<T, Error> + Send + 'static, T: Send + 'static,

pub async fn conn_mut<T, F>(&self, func: F) -> Result<T, Error>

where F: FnOnce(&mut Connection) -> Result<T, Error> + Send + 'static, T: Send + 'static,

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

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

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

Add a new column family to the DB.

pub fn transaction(&self) -> DBTransaction

Helper to create new transaction for this database.

pub async fn vacuum(&self) -> Result<(), Error>

Vacuum database

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl KeyValueDB for Database

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

Remove a value by key, returning the old value

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

Check for the existence of a value by key.

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

Check for the existence of a value by prefix.

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

Get the first value matching the given prefix.

fn cleanup(&self) -> Pin<Box<dyn Future<Output = Result<()>> + Send + '_>>

Vacuum database

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

Get a value by key.

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

Write a transaction of changes to the backing store.

fn iter<'a, T: Send + 'static, C: Send + 'static, F: FnMut(&mut C, DBKeyValueRef<'_>) -> Result<Option<T>> + Send + Sync + 'static>( &'a self, col: u32, prefix: Option<&'a [u8]>, context: C, f: F, ) -> Pin<Box<dyn Future<Output = Result<(C, 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: Send + 'static, C: Send + 'static, F: FnMut(&mut C, DBKeyRef<'_>) -> Result<Option<T>> + Send + Sync + 'static>( &'a self, col: u32, prefix: Option<&'a [u8]>, context: C, f: F, ) -> Pin<Box<dyn Future<Output = Result<(C, 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 transaction(&self) -> DBTransaction

Helper to create a new transaction.