Struct DatabaseBuilder 

pub struct DatabaseBuilder<O: Openable> { /* private fields */ }

Database builder

Implementations

impl<O: Openable> Builder<O>

pub fn open(self) -> Result<O>

Opens the database, creating it if it does not exist.

Errors

Errors if an I/O error occurred, or if the database can not be opened.

pub fn journal_compression(self, comp: CompressionType) -> Self

Sets the compression type to use for large values that are written into the journal file.

pub fn manual_journal_persist(self, flag: bool) -> Self

If false, write batches or transactions automatically flush data to the operating system.

Default = false

Set to true to handle persistence manually, e.g. manually using PersistMode::SyncData for ACID transactions.

pub fn worker_threads(self, n: usize) -> Self

Sets the number of worker threads.

Default = min(# CPU cores, 4)

Panics

Panics, if below 1.

pub fn max_cached_files(self, n: Option<usize>) -> Self

Sets the upper limit for cached file descriptors.

Note

Setting to None is currently not supported.

Panics

Panics if n < 10 or None.

pub fn cache_size(self, size_bytes: u64) -> Self

Sets the cache capacity in bytes.

It is recommended to configure the block cache capacity to be ~20-25% of the available memory - or more if the data set fully fits into memory.

pub fn max_journaling_size(self, bytes: u64) -> Self

Maximum size of all journals in bytes.

Default = 512 MiB

Panics

Panics if < 64 MiB.

Same as max_total_wal_size in RocksDB.

pub fn temporary(self, flag: bool) -> Self

Sets the Database to clean upon drop.

Examples

let db = Database::builder(&folder).temporary(true).open()?;

assert!(folder.try_exists()?);
drop(db);
assert!(!folder.try_exists()?);