Struct RedDBOptions 

pub struct RedDBOptions {

    pub mode: StorageMode,
    pub data_path: Option<PathBuf>,
    pub read_only: bool,
    pub create_if_missing: bool,
    pub verify_checksums: bool,
    pub durability_mode: DurabilityMode,
    pub group_commit: GroupCommitOptions,
    pub auto_checkpoint_pages: u32,
    pub cache_pages: usize,
    pub snapshot_retention: usize,
    pub export_retention: usize,
    pub feature_gates: CapabilitySet,
    pub force_create: bool,
    pub metadata: BTreeMap<String, String>,
    pub remote_backend: Option<Arc<dyn RemoteBackend>>,
    pub remote_backend_atomic: Option<Arc<dyn AtomicRemoteBackend>>,
    pub remote_key: Option<String>,
    pub replication: ReplicationConfig,
    pub auth: AuthConfig,
    pub auto_index_id: bool,
}

Fields

mode: StorageMode

data_path: Option<PathBuf>

read_only: bool

create_if_missing: bool

verify_checksums: bool

durability_mode: DurabilityMode

group_commit: GroupCommitOptions

auto_checkpoint_pages: u32

cache_pages: usize

snapshot_retention: usize

export_retention: usize

feature_gates: CapabilitySet

force_create: bool

metadata: BTreeMap<String, String>

remote_backend: Option<Arc<dyn RemoteBackend>>

Optional remote storage backend for snapshot transport.

remote_backend_atomic: Option<Arc<dyn AtomicRemoteBackend>>

Optional CAS-capable handle to the same backend, populated by the factory when the configured backend implements AtomicRemoteBackend (S3/local always; HTTP only when RED_HTTP_CONDITIONAL_WRITES=true). None for backends that do not provide compare-and-swap (Turso, D1, plain HTTP). LeaseStore and any future CAS consumer pull from this field.

remote_key: Option<String>

Remote object key used by the remote backend.

replication: ReplicationConfig

Replication configuration.

auth: AuthConfig

Authentication & authorization configuration.

auto_index_id: bool

Auto-create a HASH index on a user id column the first time a row carrying that column is inserted into a collection. See UnifiedStoreConfig::auto_index_id. Defaults to true; set to false to opt out per workload (e.g. ingest pipelines that don’t need point-lookups by id).

Implementations

impl RedDBOptions

pub fn persistent<P: Into<PathBuf>>(path: P) -> Self

pub fn in_memory() -> Self

Ephemeral, tempfile-backed database.

The underlying storage is a real persistent file placed under the system temp directory with a unique name — there is no longer a true in-memory execution mode. Prefer RedDBOptions::persistent when the data should outlive the process.

pub fn with_mode(self, mode: StorageMode) -> Self

pub fn with_data_path<P: Into<PathBuf>>(self, path: P) -> Self

pub fn with_read_only(self, read_only: bool) -> Self

pub fn with_auto_checkpoint(self, pages: u32) -> Self

pub fn with_durability_mode(self, mode: DurabilityMode) -> Self

pub fn with_group_commit_window_ms(self, window_ms: u64) -> Self

pub fn with_group_commit_max_statements(self, max_statements: usize) -> Self

pub fn with_group_commit_max_wal_bytes(self, max_wal_bytes: u64) -> Self

pub fn with_cache_pages(self, pages: usize) -> Self

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

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

pub fn with_metadata<K: Into<String>, V: Into<String>>( self, key: K, value: V, ) -> Self

pub fn with_auto_index_id(self, enabled: bool) -> Self

Toggle the implicit HASH index on user id columns at first insert (#112). Defaults to enabled — pass false to fall back to the legacy “scan unless CREATE INDEX is issued” behaviour.

pub fn with_capability(self, capability: Capability) -> Self

pub fn with_remote_backend( self, backend: Arc<dyn RemoteBackend>, key: impl Into<String>, ) -> Self

Attach a remote storage backend for snapshot transport.

On open, the database snapshot is downloaded from the remote key to the local data path. On flush, the local file is uploaded back to the remote backend under the same key.

pub fn with_atomic_remote_backend( self, backend: Arc<dyn AtomicRemoteBackend>, ) -> Self

Attach a CAS-capable backend handle. Pass the same Arc as with_remote_backend (factories should construct the backend once and call both setters); this method exists so the type system, not runtime config, decides whether LeaseStore is reachable.

pub fn with_replication(self, config: ReplicationConfig) -> Self

pub fn with_auth(self, config: AuthConfig) -> Self

pub fn resolved_path(&self, fallback: impl AsRef<Path>) -> PathBuf

pub fn remote_namespace_prefix(&self) -> String

pub fn default_backup_head_key(&self) -> String

pub fn default_snapshot_prefix(&self) -> String

pub fn default_wal_archive_prefix(&self) -> String

pub fn has_capability(&self, capability: Capability) -> bool

Trait Implementations

impl Clone for RedDBOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedDBOptions

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

Formats the value using the given formatter.

impl Default for RedDBOptions

fn default() -> Self

Returns the “default value” for a type.