Struct fjall::Config

pub struct Config { /* private fields */ }

Global keyspace configuration

Implementations

impl Config

pub fn new<P: AsRef<Path>>(path: P) -> Self

Creates a new configuration

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 flush_workers(self, n: usize) -> Self

Sets the amount of flush workers

Default = # CPU cores

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

Sets the amount of compaction workers

Default = # CPU cores

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

Sets the upper limit for open file descriptors.

Default = 960

Panics

Panics if n < 2.

pub fn block_cache(self, block_cache: Arc<BlockCache>) -> Self

Sets the block cache.

Defaults to a block cache with 16 MiB of capacity shared between all partitions inside this keyspace.

pub fn blob_cache(self, blob_cache: Arc<BlobCache>) -> Self

Sets the blob cache.

Defaults to a block cache with 16 MiB of capacity shared between all partitions inside this keyspace.

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

Max size of all journals in bytes.

Default = 512 MiB

Panics

Panics if bytes < 24 MiB.

This option should be at least 24 MiB, as one journal takes up at least 16 MiB, so anything less will immediately stall the system.

Same as max_total_wal_size in RocksDB.

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

Max size of all memtables in bytes.

Similar to db_write_buffer_size in RocksDB, however it is disabled by default in RocksDB.

Set to u64::MAX to disable it.

Default = 64 MiB

Panics

Panics if bytes < 1 MiB.

pub fn fsync_ms(self, ms: Option<u16>) -> Self

If Some, starts an fsync thread that asynchronously persists data.

Default = 1 second

Panics

Panics if ms is 0

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

Opens a keyspace using the config.

Errors

Will return Err if an IO error occurs.

pub fn open_transactional(self) -> Result<TxKeyspace>

Opens a transactional keyspace using the config.

Errors

Will return Err if an IO error occurs.

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

Sets the Keyspace to clean upon drop.

Examples

let keyspace = Config::new(&folder).temporary(true).open()?;

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.