Struct SqliteConnectOptions

pub struct SqliteConnectOptions { /* private fields */ }

Available on crate feature sqlite only.

Options and flags which can be used to configure a SQLite connection.

A value of SqliteConnectOptions can be parsed from a connection URL, as described by SQLite.

URL	Description
sqlite::memory:	Open an in-memory database.
sqlite:data.db	Open the file data.db in the current directory.
sqlite://data.db	Open the file data.db in the current directory.
sqlite:///data.db	Open the file data.db from the root (/) directory.
sqlite://data.db?mode=ro	Open the file data.db for read-only access.

Example

use sqlx::sqlite::{SqliteConnectOptions, SqliteJournalMode};
use std::str::FromStr;

let conn = SqliteConnectOptions::from_str("sqlite://data.db")?
    .journal_mode(SqliteJournalMode::Wal)
    .read_only(true)
    .connect().await?;

Implementations

impl SqliteConnectOptions

pub fn new() -> Self

Construct Self with default options.

See the source of this method for the current defaults.

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 shared_cache(self, on: bool) -> Self

Set the SQLITE_OPEN_SHAREDCACHE flag.

By default, this is disabled.

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 page_size(self, page_size: u32) -> Self

Sets the page_size setting for the database connection.

The default page_size setting is 4096.

pub fn pragma<K, V>(self, key: K, value: V) -> Self

where K: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Sets custom initial pragma for the database connection.

pub fn collation<N, F>(self, name: N, collate: F) -> Self

where N: Into<Arc<str>>, F: Fn(&str, &str) -> Ordering + Send + Sync + 'static,

Add a custom collation for comparing strings in SQL.

If a collation with the same name already exists, it will be replaced.

See sqlite3_create_collation() for details.

Note this excerpt:

The collating function must obey the following properties for all strings A, B, and C:

If A==B then B==A.
If A==B and B==C then A==C.
If A<B then B>A.
If A<B and B<C then A<C.

If a collating function fails any of the above constraints and that collating function is registered and used, then the behavior of SQLite is undefined.

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

Set to true to signal to SQLite that the database file is on read-only media.

If enabled, SQLite assumes the database file cannot be modified, even by higher privileged processes, and so disables locking and change detection. This is intended to improve performance but can produce incorrect query results or errors if the file does change.

Note that this is different from the SQLITE_OPEN_READONLY flag set by .read_only(), though the documentation suggests that this does imply SQLITE_OPEN_READONLY.

See sqlite3_open (subheading “URI Filenames”) for details.

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

Sets the threading mode for the database connection.

The default setting is false corersponding to using OPEN_NOMUTEX, if true then OPEN_FULLMUTEX.

See open for more details.

Note

Setting this to true may help if you are getting access violation errors or segmentation faults, but will also incur a significant performance penalty. You should leave this set to false if at all possible.

If you do end up needing to set this to true for some reason, please open an issue as this may indicate a concurrency bug in SQLx. Please provide clear instructions for reproducing the issue, including a sample database schema if applicable.

pub fn thread_name( self, generator: impl Fn(u64) -> String + Send + Sync + 'static, ) -> Self

Provide a callback to generate the name of the background worker thread.

The value passed to the callback is an auto-incremented integer for use as the thread ID.

pub fn command_buffer_size(self, size: usize) -> Self

Set the maximum number of commands to buffer for the worker thread before backpressure is applied.

Given that most commands sent to the worker thread involve waiting for a result, the command channel is unlikely to fill up unless a lot queries are executed in a short period but cancelled before their full resultsets are returned.

pub fn row_buffer_size(self, size: usize) -> Self

Set the maximum number of rows to buffer back to the calling task when a query is executed.

If the calling task cannot keep up, backpressure will be applied to the worker thread in order to limit CPU and memory usage.

Trait Implementations

impl Clone for SqliteConnectOptions

fn clone(&self) -> SqliteConnectOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConnectOptions for SqliteConnectOptions

type Connection = SqliteConnection

fn connect(&self) -> BoxFuture<'_, Result<Self::Connection, Error>>

where Self::Connection: Sized,

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

fn log_statements(&mut self, level: LevelFilter) -> &mut Self

Log executed statements with the specified level

fn log_slow_statements( &mut self, level: LevelFilter, duration: Duration, ) -> &mut Self

Log executed statements with a duration above the specified duration at the specified level.

fn disable_statement_logging(&mut self) -> &mut Self

Entirely disables statement logging (both slow and regular).

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 From<SqliteConnectOptions> for AnyConnectOptions

fn from(options: SqliteConnectOptions) -> Self

Converts to this type from the input type.

impl FromStr for SqliteConnectOptions

type Err = Error

The associated error which can be returned from parsing.

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

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

impl TryFrom<AnyConnectOptions> for SqliteConnectOptions

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AnyConnectOptions) -> Result<Self, Self::Error>

Performs the conversion.