Struct sqlx::sqlite::SqliteConnectOptions

pub struct SqliteConnectOptions { /* fields omitted */ }

This is supported 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 URI, as described by SQLite.

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

This is supported on crate feature sqlite only.

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

This is supported on crate feature sqlite only.

Sets the name of the database file.

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

This is supported on crate feature sqlite only.

Set the enforcement of foreign key constriants.

By default, this is enabled.

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

This is supported on crate feature sqlite only.

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 read_only(self, read_only: bool) -> SqliteConnectOptions

This is supported on crate feature sqlite only.

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

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

This is supported on crate feature sqlite only.

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

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

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

This is supported on crate feature sqlite only.

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.

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

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(
    uri: &str
) -> Result<SqliteConnectOptions, <SqliteConnectOptions as FromStr>::Err>

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