Struct SingleWriterTxDatabase 

pub struct SingleWriterTxDatabase { /* private fields */ }

Single-writer transactional database

Implementations

impl TxDatabase

pub fn builder(path: impl AsRef<Path>) -> DatabaseBuilder<Self>

Creates a new database builder to create or open a database at path.

pub fn write_tx(&self) -> WriteTransaction<'_>

Starts a new writeable transaction.

pub fn read_tx(&self) -> Snapshot

Starts a new read-only transaction (a.k.a. Snapshot).

pub fn persist(&self, mode: PersistMode) -> Result<()>

Flushes the active journal. The durability depends on the PersistMode used.

Persisting only affects durability, NOT consistency! Even without flushing data is crash-safe.

Examples

let db = SingleWriterTxDatabase::builder(folder).open()?;
let items = db.keyspace("my_items", KeyspaceCreateOptions::default)?;

items.insert("a", "hello")?;

db.persist(PersistMode::SyncAll)?;

Errors

Returns error, if an IO error occurred.

pub fn keyspace( &self, name: &str, create_options: impl FnOnce() -> KeyspaceCreateOptions, ) -> Result<SingleWriterTxKeyspace>

Creates or opens a keyspace.

If the keyspace does not yet exist, it will be created configured with create_options. Otherwise simply a handle to the existing keyspace will be returned.

Keyspace names can be up to 255 characters long and can not be empty.

Errors

Returns error, if an IO error occurred.

Panics

Panics if the keyspace name is invalid.

pub fn keyspace_count(&self) -> usize

Returns the number of keyspaces.

pub fn list_keyspace_names(&self) -> Vec<StrView>

Gets a list of all keyspace names in the database.

pub fn keyspace_exists(&self, name: &str) -> bool

Returns true if the keyspace with the given name exists.

pub fn write_buffer_size(&self) -> u64

Returns the current write buffer size (active + sealed memtables).

pub fn journal_count(&self) -> usize

Returns the number of journal fragments on disk.

pub fn disk_space(&self) -> Result<u64>

Returns the disk space usage of the entire database.

Errors

Returns error, if an IO error occurred.

pub fn open(config: Config) -> Result<Self>

Opens a database in the given directory.

Errors

Returns error, if an IO error occurred.

Trait Implementations

impl Clone for TxDatabase

fn clone(&self) -> TxDatabase

Returns a duplicate of the value.

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

Performs copy-assignment from source.