Struct SqliteConnectOptions

pub struct SqliteConnectOptions { /* private fields */ }

Implementations

impl SqliteConnectOptions

pub fn new() -> Self

pub fn filename(self, filename: impl AsRef<Path>) -> Self

Sets the name of the database file.

pub fn foreign_keys(self, on: bool) -> Self

Set the enforcement of foreign key constraints.

By default, this is enabled.

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

Sets the journal mode for the database connection.

The default journal mode is WAL. For most use cases this can be significantly faster but there are disadvantages.

pub fn locking_mode(self, mode: SqliteLockingMode) -> Self

Sets the locking mode for the database connection.

The default locking mode is NORMAL.

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

Sets the access mode to open the database for read-only access.

pub fn create_if_missing(self, create: bool) -> Self

Sets the access mode to create the database file if the file does not exist.

By default, a new file will not be created if one is not found.

pub fn statement_cache_capacity(self, capacity: usize) -> Self

Sets the capacity of the connection’s statement cache in a number of stored distinct statements. Caching is handled using LRU, meaning when the amount of queries hits the defined limit, the oldest statement will get dropped.

The default cache capacity is 100 statements.

pub fn busy_timeout(self, timeout: Duration) -> Self

Sets a timeout value to wait when the database is locked, before returning a busy timeout error.

The default busy timeout is 5 seconds.

pub fn synchronous(self, synchronous: SqliteSynchronous) -> Self

Sets the synchronous setting for the database connection.

The default synchronous settings is FULL. However, if durability is not a concern, then NORMAL is normally all one needs in WAL mode.

pub fn auto_vacuum(self, auto_vacuum: SqliteAutoVacuum) -> Self

Sets the auto_vacuum setting for the database connection.

The default auto_vacuum setting is NONE.

pub fn shared_cache(self, on: bool) -> Self

Set the SQLITE_OPEN_SHAREDCACHE flag.

By default, this is disabled.

Trait Implementations

impl Clone for SqliteConnectOptions

fn clone(&self) -> SqliteConnectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConnectionFactory for SqliteConnectOptions

fn connect( &self, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Connection + 'static>>> + Send>>

Establish a new database connection with the options specified by ConnectionOptions.

fn get_metadata(&self) -> Box<dyn ConnectionFactoryMetadata>

Returns the ConnectionFactoryMetadata about the product this ConnectionFactory is applicable to.

impl Debug for SqliteConnectOptions

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

Formats the value using the given formatter.

impl Default for SqliteConnectOptions

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for SqliteConnectOptions

type Err = RsdbcErrors

The associated error which can be returned from parsing.

fn from_str(uri: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.