Struct Config

pub struct Config(/* private fields */);

Top-level configuration for the system.

Examples

let _config = sled::Config::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 = sled::Config::default()
    .path("/path/to/data".to_owned())
    .read_only(true);

Implementations

impl Config

pub fn new() -> Config

Returns a default Config

pub fn path<P>(self, path: P) -> Config

where P: AsRef<Path>,

Set the path of the database (builder).

pub fn open(&self) -> Result<Db, Error>

Opens a Db based on the provided config.

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

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

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

whether to run in read-only mode

pub fn cache_capacity(self, to: u64) -> Config

maximum size for the system page cache

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

whether to use zstd compression

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

the compression factor to use with zstd compression

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

number of ms between IO buffer flushes

pub fn snapshot_after_ops(self, to: u64) -> Config

number of operations between page table snapshots

pub fn segment_cleanup_threshold(self, to: u8) -> Config

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

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

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

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

the file segment selection mode

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

snapshot file location

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

print a performance profile when the Config is dropped

pub fn idgen_persist_interval(self, to: u64) -> Config

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

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 Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl Deref for Config

type Target = Inner

The resulting type after dereferencing.

fn deref(&self) -> &Inner

Dereferences the value.