Struct sled::ConfigBuilder

pub struct ConfigBuilder { /* fields omitted */ }

Top-level configuration for the system.

Examples

let _config = pagecache::ConfigBuilder::default()
    .path("/path/to/data".to_owned())
    .cache_capacity(10_000_000_000)
    .flush_every_ms(Some(1000))
    .snapshot_after_ops(100_000);

// Read-only mode
let _config = pagecache::ConfigBuilder::default()
    .path("/path/to/data".to_owned())
    .read_only(true);

Methods

impl ConfigBuilder

pub fn new() -> ConfigBuilder

Returns a default ConfigBuilder

pub fn path<P>(self, path: P) -> ConfigBuilder where
    P: AsRef<Path>, 

Set the path of the database (builder).

pub fn merge_operator(
    self,
    mo: fn(&[u8], Option<&[u8]>, &[u8]) -> Option<Vec<u8>>
) -> ConfigBuilder

Set the merge operator that can be relied on during merges in the PageCache.

pub fn build(self) -> Config

Finalize the configuration.

Panics

This function will panic if it is not possible to open the files for performing database IO, or if the provided configuration fails some basic sanity checks.

pub fn io_bufs(self, to: usize) -> ConfigBuilder

number of io buffers

pub fn io_buf_size(self, to: usize) -> ConfigBuilder

size of each io flush buffer. MUST be multiple of 512!

pub fn blink_node_split_size(self, to: usize) -> ConfigBuilder

b-link tree node size in bytes before splitting

pub fn page_consolidation_threshold(self, to: usize) -> ConfigBuilder

page consolidation threshold

pub fn temporary(self, to: bool) -> ConfigBuilder

deletes the database after drop. if no path is set, uses /dev/shm on linux

pub fn read_only(self, to: bool) -> ConfigBuilder

whether to run in read-only mode

pub fn cache_bits(self, to: usize) -> ConfigBuilder

log base 2 of the number of cache shards

pub fn cache_capacity(self, to: usize) -> ConfigBuilder

maximum size for the system page cache

pub fn use_compression(self, to: bool) -> ConfigBuilder

whether to use zstd compression

pub fn compression_factor(self, to: i32) -> ConfigBuilder

the compression factor to use with zstd compression

pub fn flush_every_ms(self, to: Option<u64>) -> ConfigBuilder

number of ms between IO buffer flushes

pub fn snapshot_after_ops(self, to: usize) -> ConfigBuilder

number of operations between page table snapshots

pub fn segment_cleanup_threshold(self, to: f64) -> ConfigBuilder

the proportion of remaining valid pages in the segment before GC defragments it

pub fn segment_cleanup_skew(self, to: usize) -> ConfigBuilder

the cleanup threshold skew in percentage points between the first and last segments

pub fn segment_mode(self, to: SegmentMode) -> ConfigBuilder

the file segment selection mode

pub fn snapshot_path(self, to: Option<PathBuf>) -> ConfigBuilder

snapshot file location

pub fn print_profile_on_drop(self, to: bool) -> ConfigBuilder

print a performance profile when the Config is dropped

pub fn idgen_persist_interval(self, to: usize) -> ConfigBuilder

generated IDs are persisted at this interval. during recovery we skip twice this number

pub fn async_io(self, to: bool) -> ConfigBuilder

perform IO operations on a threadpool

pub fn async_io_threads(self, to: usize) -> ConfigBuilder

set the number of threads in the IO threadpool. defaults to # logical CPUs.

Trait Implementations

impl Clone for ConfigBuilder

fn clone(&self) -> ConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ConfigBuilder

fn default() -> ConfigBuilder

Returns the "default value" for a type.

impl Serialize for ConfigBuilder

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl PartialEq<ConfigBuilder> for ConfigBuilder

fn eq(&self, other: &ConfigBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConfigBuilder) -> bool

This method tests for !=.

impl Send for ConfigBuilder

impl<'de> Deserialize<'de> for ConfigBuilder

fn deserialize<__D>(
    __deserializer: __D
) -> Result<ConfigBuilder, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Debug for ConfigBuilder

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.