Skip to main content

SqliteConfig

Struct SqliteConfig 

Source
pub struct SqliteConfig {
    pub path: DbPath,
    pub flags: OpenFlags,
    pub journal_mode: JournalMode,
    pub synchronous_mode: SynchronousMode,
    pub temp_store: TempStore,
    pub cache_size: u32,
    pub wal_autocheckpoint: u32,
    pub page_size: u32,
    pub mmap_size: u64,
}
Expand description

Configuration for SQLite storage backend

Fields§

§path: DbPath§flags: OpenFlags§journal_mode: JournalMode§synchronous_mode: SynchronousMode§temp_store: TempStore§cache_size: u32§wal_autocheckpoint: u32§page_size: u32§mmap_size: u64

Implementations§

Source§

impl SqliteConfig

Source

pub fn new<P: AsRef<Path>>(path: P) -> Self

Create a new SqliteConfig with the specified database path

Source

pub fn safe<P: AsRef<Path>>(path: P) -> Self

Create a safety-first configuration optimized for data integrity

  • WAL journal mode for crash recovery
  • FULL synchronous mode for maximum durability
  • FILE temp store for persistence
  • Conservative pool size
Source

pub fn fast<P: AsRef<Path>>(path: P) -> Self

Create a high-performance configuration optimized for speed

  • MEMORY journal mode for fastest writes
  • OFF synchronous mode for minimal disk I/O
  • MEMORY temp store for fastest temp operations
  • Larger pool size for concurrency
Source

pub fn tmpfs() -> Self

Create a tmpfs configuration for temporary database storage

  • Tmpfs-backed database with WAL mode for concurrent access
  • Uses /tmp which may or may not be tmpfs (system-dependent)
  • WAL journal mode for concurrent readers + single writer
  • OFF synchronous mode for maximum speed
  • MEMORY temp store
  • Automatic cleanup on drop
Source

pub fn in_memory() -> Self

Create an in-memory configuration for production use

  • RAM-only database with WAL mode for concurrent access
  • Uses /dev/shm on Linux, temp dir on other platforms
  • WAL journal mode for concurrent readers + single writer
  • NORMAL synchronous mode (safe for RAM storage)
  • MEMORY temp store
  • Automatic cleanup on drop
Source

pub fn test() -> Self

Create a test configuration optimized for testing with in-memory database

  • RAM-only database with WAL mode for concurrent access
  • Uses /dev/shm on Linux, temp dir on other platforms
  • WAL journal mode for concurrent readers + single writer
  • FULL synchronous mode for test safety
  • MEMORY temp store for fastest temp operations
  • Automatic cleanup on drop
Source

pub fn path<P: AsRef<Path>>(self, path: P) -> Self

Set the database file path

Source

pub fn flags(self, flags: OpenFlags) -> Self

Set the SQLite open flags

Source

pub fn journal_mode(self, mode: JournalMode) -> Self

Set the journal mode

Source

pub fn synchronous_mode(self, mode: SynchronousMode) -> Self

Set the synchronous mode

Source

pub fn temp_store(self, store: TempStore) -> Self

Set the temp store location

Source

pub fn cache_size(self, size_kb: u32) -> Self

Set the cache size in KB (will be negated when passed to SQLite)

Source

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

Set WAL auto-checkpoint threshold in pages (0 = disable)

Source

pub fn page_size(self, size: u32) -> Self

Set the page size in bytes (must be a power of 2 between 512 and 65536) Note: This must be set before the database is created. Changing page size on an existing database requires a VACUUM operation.

Source

pub fn mmap_size(self, size: u64) -> Self

Set the memory-mapped I/O size in bytes (0 = disabled) Larger values can improve read performance for in-memory databases

Trait Implementations§

Source§

impl Clone for SqliteConfig

Source§

fn clone(&self) -> SqliteConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SqliteConfig

Source§

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

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

impl Default for SqliteConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

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<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> 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