Struct sqlx::SqliteConnection

pub struct SqliteConnection { /* fields omitted */ }

This is supported on crate feature sqlite only.

A connection to a Sqlite database.

Implementations

impl SqliteConnection

pub fn as_raw_handle(&mut self) -> *mut sqlite3

Returns the underlying sqlite3* connection handle

pub fn create_collation(
    &mut self,
    name: &str,
    compare: impl Send + Sync + Fn(&str, &str) -> Ordering + 'static
) -> Result<(), Error>

Trait Implementations

impl<'c> Acquire<'c> for &'c mut SqliteConnection

type Database = Sqlite

type Connection = &'c mut <Sqlite as Database>::Connection

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'c mut SqliteConnection as Acquire<'c>>::Connection, Error>> + 'c + Send, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, Sqlite>, Error>> + 'c + Send, Global>>

impl Connection for SqliteConnection

type Database = Sqlite

type Options = SqliteConnectOptions

pub fn close(
    self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static + Send, Global>>

Explicitly close this database connection.

pub fn ping(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send, Global>>

Checks if a connection to the database is still valid.

pub fn begin(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'_, <SqliteConnection as Connection>::Database>, Error>> + Send, Global>> where
    SqliteConnection: Sized, 

Begin a new transaction or establish a savepoint within the active transaction.

pub fn cached_statements_size(&self) -> usize

The number of statements currently cached in the connection.

pub fn clear_cached_statements(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send, Global>>

Removes all statements from the cache, closing them on the server if needed.

pub fn transaction<F, R, E>(
    &mut self,
    callback: F
) -> Pin<Box<dyn Future<Output = Result<R, E>> + Send, Global>> where
    F: for<'c> FnOnce(&'c mut Transaction<'_, Self::Database>) -> Pin<Box<dyn Future<Output = Result<R, E>> + 'c + Send, Global>> + 'static + Send + Sync,
    R: Send,
    E: From<Error> + Send, 

Execute the function inside a transaction.

pub fn connect(
    url: &str
) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + 'static + Send, Global>>

Establish a new database connection.

pub fn connect_with(
    options: &Self::Options
) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send, Global>>

Establish a new database connection with the provided options.

impl Debug for SqliteConnection

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

Formats the value using the given formatter.

impl Drop for SqliteConnection

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'c> Executor<'c> for &'c mut SqliteConnection

type Database = Sqlite

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<SqliteQueryResult, SqliteRow>, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, <&'c mut SqliteConnection as Executor<'c>>::Database>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<SqliteRow>, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, <&'c mut SqliteConnection as Executor<'c>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    _parameters: &[SqliteTypeInfo]
) -> Pin<Box<dyn Future<Output = Result<SqliteStatement<'q>, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

pub fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

pub fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

pub fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

pub fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

pub fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

pub fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + 'e + Send, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.

impl Migrate for SqliteConnection

pub fn ensure_migrations_table(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send, Global>>

pub fn version(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<Option<(i64, bool)>, MigrateError>> + Send, Global>>

pub fn lock(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send, Global>>

pub fn unlock(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send, Global>>

pub fn validate<'e, 'm>(
    &'e mut self,
    migration: &'m Migration
) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + 'm + Send, Global>> where
    'e: 'm, 

pub fn apply<'e, 'm>(
    &'e mut self,
    migration: &'m Migration
) -> Pin<Box<dyn Future<Output = Result<Duration, MigrateError>> + 'm + Send, Global>> where
    'e: 'm, 

pub fn revert<'e, 'm>(
    &'e mut self,
    migration: &'m Migration
) -> Pin<Box<dyn Future<Output = Result<Duration, MigrateError>> + 'm + Send, Global>> where
    'e: 'm,