Skip to main content

DatabaseConfig

Struct DatabaseConfig 

Source
pub struct DatabaseConfig {
    pub group_commit: bool,
    pub memtable_size_limit: usize,
    pub wal_enabled: bool,
    pub sync_mode: SyncMode,
    pub read_only: bool,
    pub enable_ordered_index: bool,
    pub group_commit_config: GroupCommitSettings,
    pub default_index_policy: IndexPolicy,
}
Expand description

Database configuration

Fields§

§group_commit: bool

Enable group commit for better write throughput

§memtable_size_limit: usize

Maximum memory for memtables before flush (bytes)

§wal_enabled: bool

Enable WAL for durability

§sync_mode: SyncMode

Sync mode: fsync after every commit vs periodic

§read_only: bool

Read-only mode

§enable_ordered_index: bool
👎Deprecated since 0.2.0:

Use default_index_policy field instead. This field will be removed in v0.3.0. Set IndexPolicy::ScanOptimized for ordered index, WriteOptimized to disable.

Enable ordered index for O(log N) prefix scans

§Deprecation Notice

DEPRECATED since 0.2.0: Use default_index_policy instead for per-table control. This field will be removed in v0.3.0.

§Migration Guide

Replace:

DatabaseConfig { enable_ordered_index: true, .. }  // Old API
DatabaseConfig { enable_ordered_index: false, .. } // Old API

With:

DatabaseConfig { default_index_policy: IndexPolicy::ScanOptimized, .. }  // Ordered index enabled
DatabaseConfig { default_index_policy: IndexPolicy::WriteOptimized, .. } // Ordered index disabled

§Behavior

When false, saves ~134 ns/op on writes (20% speedup) but scan_prefix becomes O(N) instead of O(log N + K).

Set to false for write-heavy workloads without range scans.

Set to false for write-heavy workloads without range scans.

§group_commit_config: GroupCommitSettings

Group commit configuration

§default_index_policy: IndexPolicy

Default index policy for tables not explicitly configured

This replaces the global enable_ordered_index toggle with fine-grained per-table control. Use index_registry to configure individual tables.

PolicyInsert CostScan CostUse Case
WriteOptimizedO(1)O(N)High-write, rare scan
BalancedO(1) amortO(output+logK)Mixed OLTP
ScanOptimizedO(log N)O(logN + K)Analytics, range query
AppendOnlyO(1)O(N)Time-series logs

Implementations§

Source§

impl DatabaseConfig

Source

pub fn throughput_optimized() -> Self

Create config optimized for throughput (Fast Mode)

  • Disables ordered index (saves ~134 ns/op)
  • Uses high-throughput group commit settings
  • Suitable for append-only workloads
Source

pub fn latency_optimized() -> Self

Create config optimized for latency

  • Keeps ordered index for fast range scans
  • Uses low-latency group commit settings
  • Suitable for OLTP workloads
Source

pub fn sqlite_compatible() -> Self

Create config matching SQLite defaults

Source

pub fn effective_ordered_index(&self) -> bool

Get effective ordered index setting, derived from default_index_policy.

This is the shim method for the deprecated enable_ordered_index field. It returns true if the policy requires an ordered index (ScanOptimized), and false otherwise (WriteOptimized, Balanced, AppendOnly).

§Policy Mapping
IndexPolicyReturns
ScanOptimizedtrue
Balancedfalse
WriteOptimizedfalse
AppendOnlyfalse

Note: Balanced uses lazy compaction rather than a live ordered index, so it returns false for the low-level memtable config but still supports efficient range scans via sorted runs.

Trait Implementations§

Source§

impl Clone for DatabaseConfig

Source§

fn clone(&self) -> DatabaseConfig

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 DatabaseConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DatabaseConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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