Struct DbBuilder 

pub struct DbBuilder<P>
where
    P: Into<Path>,
{ /* private fields */ }

A builder for creating a new Db instance.

This builder provides a fluent API for configuring and opening a SlateDB database. It separates the concerns of configuration options (settings) and components.

Implementations

impl<P> DbBuilder<P>

where P: Into<Path>,

pub fn new(path: P, main_object_store: Arc<dyn ObjectStore>) -> DbBuilder<P>

Creates a new builder for a database at the given path.

pub fn with_settings(self, settings: Settings) -> DbBuilder<P>

Sets the database settings.

pub fn with_wal_object_store( self, wal_object_store: Arc<dyn ObjectStore>, ) -> DbBuilder<P>

Sets the separate object store dedicated specifically for WAL.

NOTE: WAL durability and availability properties depend on the properties of the underlying object store. Make sure the configured object store is durable and available enough for your use case.

pub fn with_db_cache(self, db_cache: Arc<dyn DbCache>) -> DbBuilder<P>

Sets the cache to use for the database for caching sst blocks

SlateDB uses a cache to efficiently store and retrieve blocks and SST metadata locally. [slatedb::db_cache::SplitCache] is used by default.

pub fn with_db_cache_disabled(self) -> DbBuilder<P>

Disables the sst block/metadata cache

pub fn with_system_clock(self, clock: Arc<dyn SystemClock>) -> DbBuilder<P>

Sets the system clock to use for the database. System timestamps are used for scheduling operations such as compaction and garbage collection.

pub fn with_gc_runtime(self, gc_runtime: Handle) -> DbBuilder<P>

Sets the garbage collection runtime to use for the database.

pub fn with_compactor_builder( self, compactor_builder: CompactorBuilder<P>, ) -> DbBuilder<P>

Sets a custom CompactorBuilder for compaction orchestration.

Setting a CompactorBuilder will ignore any previous Settings::compactor_options configuration passed in through DbBuilder::with_settings since the CompactorBuilder provides its own configuration.

pub fn with_gc_builder( self, gc_builder: GarbageCollectorBuilder<P>, ) -> DbBuilder<P>

Sets a custom GarbageCollectorBuilder for garbage collection.

Setting a GarbageCollectorBuilder will ignore any previous Settings::garbage_collector_options configuration passed in through DbBuilder::with_settings since the GarbageCollectorBuilder provides its own configuration.

pub fn with_metrics_recorder( self, recorder: Arc<dyn MetricsRecorder>, ) -> DbBuilder<P>

Sets the metrics recorder to use for the database.

pub fn with_fp_registry( self, fp_registry: Arc<FailPointRegistry>, ) -> DbBuilder<P>

Sets the fail point registry to use for the database.

pub fn with_seed(self, seed: u64) -> DbBuilder<P>

Sets the seed to use for the database’s random number generator. All random behavior in SlateDB will use randomm number generators based off of this seed. This includes random bytes for UUIDs and ULIDS, as well as random pickers in cache eviction policies.

If not set, SlateDB uses the OS’s random number generator to generate a seed.

pub fn with_sst_block_size(self, block_size: SstBlockSize) -> DbBuilder<P>

Sets the block size for SSTable blocks. Blocks are the unit of reading and caching in SlateDB. Smaller blocks can reduce read amplification but may increase metadata overhead. Larger blocks are more efficient for sequential scans but may waste bandwidth for point lookups.

Note: When compression is enabled, blocks are compressed individually. Larger blocks typically achieve better compression ratios.

Arguments

• block_size - The block size variant to use (1KB, 2KB, 4KB, 8KB, 16KB, 32KB, or 64KB).

Returns

The builder instance for chaining.

pub fn with_merge_operator( self, merge_operator: Arc<dyn MergeOperator + Send + Sync>, ) -> DbBuilder<P>

Sets the merge operator to use for the database. The merge operator allows applications to bypass the traditional read/modify/write cycle by expressing partial updates using an associative operator.

Arguments

• merge_operator - An Arc-wrapped merge operator implementation.

Returns

The builder instance for chaining.

pub fn with_block_transformer( self, block_transformer: Arc<dyn BlockTransformer>, ) -> DbBuilder<P>

Sets the block transformer to use for the database. The block transformer allows custom encoding/decoding of block data before storage and after retrieval. This can be used for encryption or other transformations.

The transformer is applied after compression on write and before decompression on read. The checksum is calculated on the transformed data.

Arguments

• block_transformer - An Arc-wrapped block transformer implementation.

Returns

The builder instance for chaining.

pub async fn build(self) -> Result<Db, Error>

Builds and opens the database.