Skip to main content

WriteEngineConfig

Struct WriteEngineConfig 

Source
pub struct WriteEngineConfig {
    pub data_dir: PathBuf,
    pub wal_dir: PathBuf,
    pub memtable_flush_threshold: usize,
    pub memtable_hard_limit: usize,
    pub schema: TableSchema,
    pub durability: Durability,
    pub udt_registry: Option<UdtRegistry>,
    pub auto_compaction: bool,
    pub compaction_min_threshold: usize,
    pub compaction_max_threshold: usize,
}
Expand description

Write engine configuration

Fields§

§data_dir: PathBuf

Directory for SSTable data files

§wal_dir: PathBuf

Directory for WAL files

§memtable_flush_threshold: usize

Memtable flush threshold in bytes (default: 64MB)

§memtable_hard_limit: usize

Memtable hard limit in bytes (default: 256MB) When this limit is reached, writes will fail with an error

§schema: TableSchema

Table schema for column metadata

§durability: Durability

WAL durability mode (default: Durability::SyncEachWrite)

§udt_registry: Option<UdtRegistry>

Optional UDT registry for resolving bare CQL UDT column types to their UserType(...) marshal form at flush time (issue #929). When None (the default), a column whose data_type is a bare UDT name is written as a single simple cell (documented fallback).

§auto_compaction: bool

Whether the engine installs a default STCS compaction policy so that WriteEngine::maintenance_step performs size-tiered compaction (issue #1619). Defaults to true (compaction on). Set to false to disable compaction entirely — maintenance_step then becomes a no-op.

§compaction_min_threshold: usize

Minimum number of SSTables in a size bucket required to trigger a compaction (STCS min_threshold). Defaults to 4. Ignored when WriteEngineConfig::auto_compaction is false.

§compaction_max_threshold: usize

Maximum number of SSTables compacted together in one step (STCS max_threshold). Defaults to 32. Ignored when WriteEngineConfig::auto_compaction is false.

Implementations§

Source§

impl WriteEngineConfig

Source

pub const DEFAULT_FLUSH_THRESHOLD: usize

Default flush threshold (64 MB)

Source

pub const DEFAULT_HARD_LIMIT: usize

Default hard limit (256 MB)

Source

pub const DEFAULT_COMPACTION_MIN_THRESHOLD: usize = 4

Default STCS min_threshold (issue #1619)

Source

pub const DEFAULT_COMPACTION_MAX_THRESHOLD: usize = 32

Default STCS max_threshold (issue #1619)

Source

pub fn new(data_dir: PathBuf, wal_dir: PathBuf, schema: TableSchema) -> Self

Create a new configuration with default flush threshold

Source

pub fn with_udt_registry(self, registry: UdtRegistry) -> Self

Attach a UdtRegistry used to resolve bare CQL UDT column types at flush time (issue #929). See WriteEngineConfig::udt_registry.

Source

pub fn with_flush_threshold(self, threshold: usize) -> Self

Set a custom flush threshold

Source

pub fn with_hard_limit(self, limit: usize) -> Self

Set a custom hard limit

Source

pub fn with_durability(self, durability: Durability) -> Self

Set the WAL durability mode.

Mirrors with_flush_threshold in style. See Durability for the trade-offs between Durability::SyncEachWrite (default, production) and Durability::Disabled (bulk-load / benchmarking).

§Example
use cqlite_core::storage::write_engine::{Durability, WriteEngineConfig};

let config = WriteEngineConfig::new(data, wal, schema)
    .with_durability(Durability::Disabled);
Source

pub fn with_compaction_config(self, compaction: &CompactionConfig) -> Self

Apply a crate::config::CompactionConfig onto this write-engine configuration (issue #1619). This makes Config.storage.compaction authoritative for the write path: auto_compaction = false disables the default STCS policy so WriteEngine::maintenance_step becomes a no-op.

The compaction thresholds (compaction_min_threshold / compaction_max_threshold) keep their defaults; only the on/off switch is surfaced through the public Config today.

Trait Implementations§

Source§

impl Clone for WriteEngineConfig

Source§

fn clone(&self) -> WriteEngineConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WriteEngineConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more