Struct lsm_tree::Config

pub struct Config { /* private fields */ }

Tree configuration builder

Implementations

impl Config

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

Initializes a new config

pub fn level_count(self, n: u8) -> Self

Sets the amount of levels of the LSM tree (depth of tree).

Defaults to 7, like LevelDB and RocksDB.

Panics

Panics if n is 0.

pub fn level_ratio(self, n: u8) -> Self

Sets the size ratio between levels of the LSM tree (a.k.a. fanout, growth rate).

Defaults to 8.

Panics

Panics if n is less than 2.

pub fn block_size(self, block_size: u32) -> Self

Sets the block size.

Defaults to 4 KiB (4096 bytes).

For point read heavy workloads (get) a sensible default is somewhere between 4 - 8 KiB, depending on the average value size.

For scan heavy workloads (range, prefix), use 16 - 64 KiB which also increases compression efficiency.

Panics

Panics if the block size is smaller than 1 KiB (1024 bytes).

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

Sets the block cache.

You can create a global BlockCache and share it between multiple trees to cap global cache memory usage.

Defaults to a block cache with 8 MiB of capacity per tree.

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

Opens a tree using the config.

Errors

Will return Err if an IO error occurs.

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.