Struct SqliteConnection 

pub struct SqliteConnection { /* private fields */ }

A connection to a SQLite database.

This is a thread-safe wrapper around a SQLite database handle.

Implementations

impl SqliteConnection

pub fn open(config: &SqliteConfig) -> Result<Self, Error>

Open a new SQLite connection with the given configuration.

pub fn open_memory() -> Result<Self, Error>

Open an in-memory database.

pub fn open_file(path: impl Into<String>) -> Result<Self, Error>

Open a file-based database.

pub fn path(&self) -> &str

Get the database path.

pub fn execute_raw(&self, sql: &str) -> Result<(), Error>

Execute SQL directly without preparing (for DDL, etc.)

pub fn backup_to_path(&self, dest_path: impl AsRef<str>) -> Result<(), Error>

Backup the current database to a destination path using the SQLite backup API.

This opens (or creates) the destination database and performs an online backup from this connection’s main database into the destination’s main database.

pub fn backup_to_connection(&self, dest: &SqliteConnection) -> Result<(), Error>

Backup the current database to another open SQLite connection.

The destination must not use SQLite shared-cache mode because this wrapper cannot coordinate other connections attached to that cache.

pub fn last_insert_rowid(&self) -> i64

Get the last insert rowid.

pub fn changes(&self) -> i32

Get the number of rows changed by the last statement.

pub fn query_sync(&self, sql: &str, params: &[Value]) -> Result<Vec<Row>, Error>

Prepare and execute a query synchronously, returning all rows.

This is a blocking operation suitable for simple use cases. For async usage, use the Connection trait methods instead.

pub fn execute_sync(&self, sql: &str, params: &[Value]) -> Result<u64, Error>

Prepare and execute a statement synchronously, returning rows affected.

This is a blocking operation suitable for simple use cases. For async usage, use the Connection trait methods instead.

impl SqliteConnection

pub fn emit_busy_waiting(&self, _elapsed_secs: f64)

No-op when console feature is disabled.

pub fn emit_checkpoint_progress(&self, _pages_done: u32, _pages_total: u32)

No-op when console feature is disabled.

Trait Implementations

impl Connection for SqliteConnection

type Tx<'conn> = SqliteTransaction<'conn> where Self: 'conn

The transaction type returned by this connection.

fn dialect(&self) -> Dialect

Get the SQL dialect for this connection.

fn query( &self, _cx: &Cx, sql: &str, params: &[Value], ) -> impl Future<Output = Outcome<Vec<Row>, Error>> + Send

Execute a query and return all rows.

fn query_one( &self, _cx: &Cx, sql: &str, params: &[Value], ) -> impl Future<Output = Outcome<Option<Row>, Error>> + Send

Execute a query and return the first row, if any.

fn execute( &self, _cx: &Cx, sql: &str, params: &[Value], ) -> impl Future<Output = Outcome<u64, Error>> + Send

Execute a statement (INSERT, UPDATE, DELETE) and return rows affected.

fn insert( &self, _cx: &Cx, sql: &str, params: &[Value], ) -> impl Future<Output = Outcome<i64, Error>> + Send

Execute an INSERT and return the last inserted ID.

fn batch( &self, _cx: &Cx, statements: &[(String, Vec<Value>)], ) -> impl Future<Output = Outcome<Vec<u64>, Error>> + Send

Execute multiple statements in a batch.

fn begin( &self, cx: &Cx, ) -> impl Future<Output = Outcome<Self::Tx<'_>, Error>> + Send

Begin a transaction with default isolation level (ReadCommitted).

fn begin_with( &self, _cx: &Cx, isolation: IsolationLevel, ) -> impl Future<Output = Outcome<Self::Tx<'_>, Error>> + Send

Begin a transaction with a specific isolation level.

fn prepare( &self, _cx: &Cx, sql: &str, ) -> impl Future<Output = Outcome<PreparedStatement, Error>> + Send

Prepare a statement for repeated execution.

fn query_prepared( &self, cx: &Cx, stmt: &PreparedStatement, params: &[Value], ) -> impl Future<Output = Outcome<Vec<Row>, Error>> + Send

Execute a prepared statement and return all rows.

fn execute_prepared( &self, cx: &Cx, stmt: &PreparedStatement, params: &[Value], ) -> impl Future<Output = Outcome<u64, Error>> + Send

Execute a prepared statement (INSERT, UPDATE, DELETE) and return rows affected.

fn ping(&self, _cx: &Cx) -> impl Future<Output = Outcome<(), Error>> + Send

Check if the connection is still valid by sending a ping.

fn close(self, _cx: &Cx) -> impl Future<Output = Result<()>> + Send

Close the connection gracefully.

fn is_valid(&self, cx: &Cx) -> impl Future<Output = bool> + Send

Check if the connection is still valid (alias for ping that returns bool).

fn close_for_pool( self, cx: &Cx, ) -> impl Future<Output = Result<(), Error>> + Send

where Self: Sized,

Close the connection as part of pool retirement.

impl Drop for SqliteConnection

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for SqliteConnection

impl Sync for SqliteConnection