Struct Config 

pub struct Config { /* private fields */ }

Bf-tree configuration for advanced usage. Bf-tree is designed to work well on various workloads that you don’t have to change the default configuration. This configuration is more for advanced users who want to understand the different components of the system, rather than performance tuning.

Implementations

impl Config

pub fn new(file_path: impl AsRef<Path>, circular_buffer_size: usize) -> Config

pub fn new_with_config_file<P>(config_file_path: P) -> Config

where P: AsRef<Path>,

Constructor of Config based on a config TOML file The config file must have all fields defined ConfigFile

pub fn storage_backend(&mut self, backend: StorageBackend) -> &mut Config

Default: Std

Use std::fs::file to store/access disk data. For better performance, consider platform specific backends like: IoUringBlocking.

pub fn write_load_full_page(&mut self, load_full_page: bool) -> &mut Config

pub fn scan_promotion_rate(&mut self, prob: usize) -> &mut Config

Default: 30

prob% of chance that a page will be promoted to buffer during scan operations.

pub fn max_fence_len(&mut self, len: usize) -> &mut Config

pub fn read_record_cache(&mut self, read_full_page_cache: bool) -> &mut Config

Default: true

By default bf-tree will cache the hot records in mini page. Setting this to false will try to cache the entire base page, which is less efficient.

pub fn max_mini_page_size(&mut self, size: usize) -> &mut Config

Default: 2048

The maximum mini page size before it grows to a full page.

pub fn mini_page_binary_search(&mut self, binary_search: bool) -> &mut Config

Default: true

If set to false, the mini page will use linear search instead of binary search.

pub fn read_promotion_rate(&mut self, prob: usize) -> &mut Config

Default: 30

prob% of chance that a record will be promoted from leaf page to mini page.

pub fn cb_copy_on_access_ratio(&mut self, ratio: f64) -> &mut Config

Default: 0.1

The ratio of copy-on-access region for circular buffer.

• 0.0 means the circular buffer is a FIFO.
• 1.0 means the circular buffer is a LRU.

You don’t want to change this unless you know what you are doing.

pub fn enable_write_ahead_log( &mut self, wal_config: Arc<WalConfig>, ) -> &mut Config

Default: false

Whether to enable write ahead log, for persistency and recovery.

pub fn enable_write_ahead_log_default(&mut self) -> &mut Config

Default: false

Similar to enable_write_ahead_log, but with default WAL configuration. The path to write the write ahead log. Advanced users may want to change the WAL to point to a different location to leverage different storage patterns (WAL is always sequence write and requires durability).

pub fn cache_only(&mut self, cache_only: bool) -> &mut Config

Default: false

pub fn cb_size_byte(&mut self, cb_size_byte: usize) -> &mut Config

Default: 32 * 1024 * 1024

pub fn file_path<P>(&mut self, file_path: P) -> &mut Config

where P: AsRef<Path>,

pub fn use_snapshot(&mut self, use_snapshot: bool) -> &mut Config

Default: false

pub fn snapshot_version(&mut self, snapshot_version: u64) -> &mut Config

Default: 0

pub fn cb_max_key_len(&mut self, max_key_len: usize) -> &mut Config

pub fn cb_min_record_size(&mut self, min_record_size: usize) -> &mut Config

pub fn cb_max_record_size(&mut self, max_record_size: usize) -> &mut Config

pub fn get_cb_max_record_size(&self) -> usize

Returns the current max record size

pub fn get_cb_size_byte(&self) -> usize

pub fn leaf_page_size(&mut self, leaf_page_size: usize) -> &mut Config

pub fn get_leaf_page_size(&self) -> usize

Returns the current leaf page size

pub fn is_memory_backend(&self) -> bool

Returns true if the storage backend is in-memory (no file-backed storage).

pub fn validate(&self) -> Result<(), ConfigError>

Validate the configuration and report any invalid parameter, if found.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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

Default BfTree configuration

fn default() -> Config

Returns the “default value” for a type.