Struct SqliteConnectOptions

pub struct SqliteConnectOptions { /* private fields */ }

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.

This type also implements FromStr so you can parse it from a string containing a connection URL and then further adjust options if necessary (see example below).

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::ConnectOptions;
use sqlx::sqlite::{SqliteConnectOptions, SqliteJournalMode, SqlitePool};
use std::str::FromStr;

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

// use in a pool
let pool = SqlitePool::connect_with(opts).await?;

// or connect directly
let conn = opts.connect().await?;

Implementations

impl SqliteConnectOptions

pub fn new() -> SqliteConnectOptions

Construct Self with default options.

See the source of this method for the current defaults.

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

Sets the name of the database file.

This is a low-level API, and SQLx will apply no special treatment for ":memory:" as an in-memory database using this method. Using SqliteConnectOptions::from_str() may be preferred for simple use cases.

pub fn get_filename(&self) -> &Path

Gets the current name of the database file.

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

Set the enforcement of foreign key constraints.

SQLx chooses to enable this by default so that foreign keys function as expected, compared to other database flavors.

pub fn in_memory(self, in_memory: bool) -> SqliteConnectOptions

Set the SQLITE_OPEN_MEMORY flag.

By default, this is disabled.

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

Set the SQLITE_OPEN_SHAREDCACHE flag.

By default, this is disabled.

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

Sets the journal mode for the database connection.

Journal modes are ephemeral per connection, with the exception of the Write-Ahead Log (WAL) mode.

A database created in WAL mode retains the setting and will apply it to all connections opened against it that don’t set a journal_mode.

Opening a connection to a database created in WAL mode with a different journal_mode will erase the setting on the database, requiring an exclusive lock to do so. You may get a database is locked (corresponding to SQLITE_BUSY) error if another connection is accessing the database file at the same time.

SQLx does not set a journal mode by default, to avoid unintentionally changing a database into or out of WAL mode.

The default journal mode for non-WAL databases is DELETE, or MEMORY for in-memory databases.

For consistency, any commands in sqlx-cli which create a SQLite database will create it in WAL mode.

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

Sets the locking mode for the database connection.

The default locking mode is NORMAL.

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

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

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

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

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

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

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

Sets the auto_vacuum setting for the database connection.

The default auto_vacuum setting is NONE.

For existing databases, a change to this value does not take effect unless a VACUUM command is executed.

pub fn page_size(self, page_size: u32) -> SqliteConnectOptions

Sets the page_size setting for the database connection.

The default page_size setting is 4096.

For existing databases, a change to this value does not take effect unless a VACUUM command is executed. However, it cannot be changed in WAL mode.

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

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

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

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

Sets the threading mode for the database connection.

The default setting is false corresponding to using OPEN_NOMUTEX. If set to 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, ) -> SqliteConnectOptions

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

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

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.

pub fn vfs(self, vfs_name: impl Into<Cow<'static, str>>) -> SqliteConnectOptions

Sets the vfs parameter of the database connection.

The default value is empty, and sqlite will use the default VFS object depending on the operating system.

pub fn extension( self, extension_name: impl Into<Cow<'static, str>>, ) -> SqliteConnectOptions

Load an extension at run-time when the database connection is established, using the default entry point.

Most common SQLite extensions can be loaded using this method, for extensions where you need to specify the entry point, use extension_with_entrypoint instead.

Multiple extensions can be loaded by calling the method repeatedly on the options struct, they will be loaded in the order they are added.

let options = SqliteConnectOptions::from_str("sqlite://data.db")?
    .extension("vsv")
    .extension("mod_spatialite");

pub fn extension_with_entrypoint( self, extension_name: impl Into<Cow<'static, str>>, entry_point: impl Into<Cow<'static, str>>, ) -> SqliteConnectOptions

Load an extension with a specified entry point.

Useful when using non-standard extensions, or when developing your own, the second argument specifies where SQLite should expect to find the extension init routine.

pub fn optimize_on_close( self, enabled: bool, analysis_limit: impl Into<Option<u32>>, ) -> SqliteConnectOptions

Execute PRAGMA optimize; on the SQLite connection before closing.

The SQLite manual recommends using this for long-lived databases.

This will collect and store statistics about the layout of data in your tables to help the query planner make better decisions. Over the connection’s lifetime, the query planner will make notes about which tables could use up-to-date statistics so this command doesn’t have to scan the whole database every time. Thus, the best time to execute this is on connection close.

analysis_limit sets a soft limit on the maximum number of rows to scan per index. It is equivalent to setting Self::analysis_limit but only takes effect for the PRAGMA optimize; call and does not affect the behavior of any ANALYZE statements made during the connection’s lifetime.

If not None, the analysis_limit here overrides the global analysis_limit setting, but only for the PRAGMA optimize; call.

Not enabled by default.

See the SQLite manual for details.

pub fn analysis_limit( self, limit: impl Into<Option<u32>>, ) -> SqliteConnectOptions

Set a soft limit on the number of rows that ANALYZE touches per index.

This also affects PRAGMA optimize which is set by Self::optimize_on_close.

The value recommended by SQLite is 400. There is no default.

See the SQLite manual for details.

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 from_url(url: &Url) -> Result<SqliteConnectOptions, Error>

Parse the ConnectOptions from a URL.

fn to_url_lossy(&self) -> Url

Get a connection URL that may be used to connect to the same database as this ConnectOptions.

fn connect( &self, ) -> Pin<Box<dyn Future<Output = Result<<SqliteConnectOptions as ConnectOptions>::Connection, Error>> + Send + '_>>

where <SqliteConnectOptions as ConnectOptions>::Connection: Sized,

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

fn log_statements(self, level: LevelFilter) -> SqliteConnectOptions

Log executed statements with the specified level

fn log_slow_statements( self, level: LevelFilter, duration: Duration, ) -> SqliteConnectOptions

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

fn disable_statement_logging(self) -> Self

Entirely disables statement logging (both slow and regular).

impl Debug for SqliteConnectOptions

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

Formats the value using the given formatter.

impl Default for SqliteConnectOptions

fn default() -> SqliteConnectOptions

Returns the “default value” for a type.

impl FromStr for SqliteConnectOptions

type Err = Error

The associated error which can be returned from parsing.

fn from_str( url: &str, ) -> Result<SqliteConnectOptions, <SqliteConnectOptions as FromStr>::Err>

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