Struct DatabaseConfig 

pub struct DatabaseConfig {

    pub allow_create: bool,
    pub sorted_duplicates: bool,
    pub transactional: bool,
    pub read_only: bool,
    pub temporary: bool,
    pub deferred_write: bool,
    pub override_btree_comparator: bool,
    pub override_duplicate_comparator: bool,
    pub exclusive: bool,
    pub node_max_entries: u32,
    pub replicated: bool,
    pub key_prefixing: bool,
    pub cache_mode: CacheMode,
    pub bin_delta: bool,
    pub use_existing_config: bool,
}

Configuration for opening a database.

Specifies the configuration parameters used to open a database within an environment. Use the builder pattern to configure individual parameters.

Fields

allow_create: bool

Allow creation of a new database if it doesn’t exist.

sorted_duplicates: bool

Whether the database supports sorted duplicates.

transactional: bool

Whether the database supports transactions.

read_only: bool

Open the database in read-only mode.

temporary: bool

Whether this is a temporary database.

Temporary databases are not logged and are removed when closed.

deferred_write: bool

Whether to use deferred write mode.

Deferred write databases delay writing to disk for better performance.

override_btree_comparator: bool

Override the B-tree key comparator.

Inert as of v1.6.0: the public API has no setter for an actual comparator function, so this flag has nothing to consume. The flag and the ByteComparator trait are scheduled for removal in v2.0. Setting it to true does not change the on-disk byte order.

override_duplicate_comparator: bool

Override the duplicate data comparator.

Inert as of v1.6.0 — see override_btree_comparator.

exclusive: bool

Whether this database is exclusive to a single thread.

Inert as of v1.6.0: the noxu_dbi engine has no per-database thread-affinity enforcement; this flag is recorded but never consulted.

node_max_entries: u32

Node maximum entries (0 = use default).

replicated: bool

Whether this database participates in replication.

Inert as of v1.6.0: the noxu_dbi::DatabaseConfig has no replicated field; the replication scope is set at the env level via noxu-rep.

key_prefixing: bool

Enable key prefix compression in BIN nodes.

Plumbed through to noxu_dbi::DatabaseConfig as of v1.6.0 .

cache_mode: CacheMode

Per-database cache eviction hint.

Inert as of v1.6.0: the per-DB hint is not yet honoured by the evictor; the env-level cache mode is.

bin_delta: bool

Write BIN-deltas to the log instead of full BINs (space optimization).

Inert as of v1.6.0: the engine always emits BIN-deltas where applicable.

use_existing_config: bool

When true, opening an existing database reuses its stored config rather than applying this config.

Inert as of v1.6.0: the engine does not yet persist per-DB config across runs in a way that can be selectively re-applied.

Implementations

impl DatabaseConfig

pub fn new() -> Self

Creates a new DatabaseConfig with default settings.

pub fn set_allow_create(&mut self, allow_create: bool) -> &mut Self

Sets whether to allow creation of a new database.

pub fn set_sorted_duplicates(&mut self, sorted_duplicates: bool) -> &mut Self

Sets whether the database supports sorted duplicates.

pub fn set_transactional(&mut self, transactional: bool) -> &mut Self

Sets whether the database supports transactions.

pub fn set_read_only(&mut self, read_only: bool) -> &mut Self

Sets whether the database is read-only.

pub fn set_temporary(&mut self, temporary: bool) -> &mut Self

Sets whether this is a temporary database.

pub fn set_deferred_write(&mut self, deferred_write: bool) -> &mut Self

Sets whether to use deferred write mode.

pub fn set_override_btree_comparator( &mut self, override_btree_comparator: bool, ) -> &mut Self

Sets whether to override the B-tree comparator.

pub fn set_override_duplicate_comparator( &mut self, override_duplicate_comparator: bool, ) -> &mut Self

Sets whether to override the duplicate comparator.

pub fn set_exclusive(&mut self, exclusive: bool) -> &mut Self

Sets whether the database is exclusive.

pub fn set_node_max_entries(&mut self, node_max_entries: u32) -> &mut Self

Sets the node maximum entries.

pub fn with_allow_create(self, allow_create: bool) -> Self

Builder-style method to set allow_create.

pub fn with_sorted_duplicates(self, sorted_duplicates: bool) -> Self

Builder-style method to set sorted_duplicates.

pub fn with_transactional(self, transactional: bool) -> Self

Builder-style method to set transactional.

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

Builder-style method to set read_only.

pub fn with_temporary(self, temporary: bool) -> Self

Builder-style method to set temporary.

pub fn with_deferred_write(self, deferred_write: bool) -> Self

Builder-style method to set deferred_write.

pub fn set_replicated(&mut self, replicated: bool) -> &mut Self

Sets whether this database participates in replication.

pub fn with_replicated(self, replicated: bool) -> Self

Builder-style method to set replicated.

pub fn set_key_prefixing(&mut self, key_prefixing: bool) -> &mut Self

Sets whether key prefix compression is enabled.

pub fn with_key_prefixing(self, key_prefixing: bool) -> Self

Builder-style method to set key_prefixing.

pub fn set_cache_mode(&mut self, cache_mode: CacheMode) -> &mut Self

Sets the per-database cache eviction mode.

pub fn with_cache_mode(self, cache_mode: CacheMode) -> Self

Builder-style method to set cache_mode.

pub fn set_bin_delta(&mut self, bin_delta: bool) -> &mut Self

Sets whether BIN-deltas are written to the log.

pub fn with_bin_delta(self, bin_delta: bool) -> Self

Builder-style method to set bin_delta.

pub fn set_use_existing_config(&mut self, v: bool) -> &mut Self

Sets whether to reuse existing config when opening an existing database.

pub fn with_use_existing_config(self, v: bool) -> Self

Builder-style method to set use_existing_config.

Trait Implementations

impl Clone for DatabaseConfig

fn clone(&self) -> DatabaseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseConfig

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

Formats the value using the given formatter.

impl Default for DatabaseConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DatabaseConfig

impl PartialEq for DatabaseConfig

fn eq(&self, other: &DatabaseConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DatabaseConfig