Struct sqlx::Transaction

pub struct Transaction<'c, DB> where
    DB: Database,  { /* fields omitted */ }

An in-progress database transaction or savepoint.

A transaction starts with a call to Pool::begin or Connection::begin.

A transaction should end with a call to commit or rollback. If neither are called before the transaction goes out-of-scope, rollback is called. In other words, rollback is called on drop if the transaction is still in-progress.

A savepoint is a special mark inside a transaction that allows all commands that are executed after it was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint.

Implementations

impl<'c, DB> Transaction<'c, DB> where
    DB: Database, 

pub async fn commit(self) -> Result<(), Error>

Commits this transaction or savepoint.

pub async fn rollback(self) -> Result<(), Error>

Aborts this transaction or savepoint.

Trait Implementations

impl<'c, 't> Acquire<'t> for &'t mut Transaction<'c, Sqlite>

type Database = Sqlite

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

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

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

impl<'c, 't> Acquire<'t> for &'t mut Transaction<'c, MySql>

type Database = MySql

type Connection = &'t mut <MySql as Database>::Connection

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

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

impl<'c, 't> Acquire<'t> for &'t mut Transaction<'c, Mssql>

type Database = Mssql

type Connection = &'t mut <Mssql as Database>::Connection

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

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

impl<'c, 't> Acquire<'t> for &'t mut Transaction<'c, Any>

type Database = Any

type Connection = &'t mut <Any as Database>::Connection

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

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

impl<'c, 't> Acquire<'t> for &'t mut Transaction<'c, Postgres>

type Database = Postgres

type Connection = &'t mut <Postgres as Database>::Connection

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

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

impl<'c, DB> Debug for Transaction<'c, DB> where
    DB: Database, 

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

Formats the value using the given formatter.

impl<'c, DB> Deref for Transaction<'c, DB> where
    DB: Database, 

type Target = <DB as Database>::Connection

The resulting type after dereferencing.

pub fn deref(&self) -> &<Transaction<'c, DB> as Deref>::Target

Dereferences the value.

impl<'c, DB> DerefMut for Transaction<'c, DB> where
    DB: Database, 

pub fn deref_mut(&mut self) -> &mut <Transaction<'c, DB> as Deref>::Target

Mutably dereferences the value.

impl<'c, DB> Drop for Transaction<'c, DB> where
    DB: Database, 

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'c, 't> Executor<'t> for &'t mut Transaction<'c, MySql>

type Database = MySql

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<MySql as Database>::QueryResult, MySqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, MySql> as Executor<'t>>::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<MySqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, MySql> as Executor<'t>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<<&'t mut Transaction<'c, MySql> as Executor<'t>>::Database as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<<&'t mut Transaction<'c, MySql> as Executor<'t>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e, 

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

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

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

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, 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.

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

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

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, 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.

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

Execute the query and returns exactly one row.

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

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

impl<'c, 't> Executor<'t> for &'t mut Transaction<'c, Sqlite>

type Database = Sqlite

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Sqlite as Database>::QueryResult, SqliteRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Sqlite> as Executor<'t>>::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>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Sqlite> as Executor<'t>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<<&'t mut Transaction<'c, Sqlite> as Executor<'t>>::Database as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<<&'t mut Transaction<'c, Sqlite> as Executor<'t>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e, 

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

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

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

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, 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.

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

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

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, 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.

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

Execute the query and returns exactly one row.

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

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

impl<'c, 't> Executor<'t> for &'t mut Transaction<'c, Any>

type Database = Any

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Any as Database>::QueryResult, AnyRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Any> as Executor<'t>>::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<AnyRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Any> as Executor<'t>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<<&'t mut Transaction<'c, Any> as Executor<'t>>::Database as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<<&'t mut Transaction<'c, Any> as Executor<'t>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e, 

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

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

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

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, 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.

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

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

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, 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.

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

Execute the query and returns exactly one row.

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

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

impl<'c, 't> Executor<'t> for &'t mut Transaction<'c, Postgres>

type Database = Postgres

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Postgres as Database>::QueryResult, PgRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Postgres> as Executor<'t>>::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<PgRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Postgres> as Executor<'t>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<<&'t mut Transaction<'c, Postgres> as Executor<'t>>::Database as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<<&'t mut Transaction<'c, Postgres> as Executor<'t>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e, 

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

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

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

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, 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.

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

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

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, 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.

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

Execute the query and returns exactly one row.

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

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

impl<'c, 't> Executor<'t> for &'t mut Transaction<'c, Mssql>

type Database = Mssql

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Mssql as Database>::QueryResult, MssqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Mssql> as Executor<'t>>::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<MssqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e,
    E: 'q + Execute<'q, <&'t mut Transaction<'c, Mssql> as Executor<'t>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<<&'t mut Transaction<'c, Mssql> as Executor<'t>>::Database as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<<&'t mut Transaction<'c, Mssql> as Executor<'t>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    't: 'e, 

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

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

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

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, 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.

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

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

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, 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.

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

Execute the query and returns exactly one row.

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

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