Struct DatabaseTransaction 

pub struct DatabaseTransaction { /* private fields */ }

Defines a database transaction, whether it is an open transaction and the type of backend to use. Under the hood, a Transaction is just a wrapper for a connection where START TRANSACTION has been executed.

Implementations

impl DatabaseTransaction

pub async fn transaction_async<F, T, E>( &self, callback: F, ) -> Result<T, TransactionError<E>>

where F: for<'c> AsyncFnOnce(&'c DatabaseTransaction) -> Result<T, E> + Send, T: Send, E: Display + Debug + Send,

Execute the function inside a transaction. If the function returns an error, the transaction will be rolled back. Otherwise, the transaction will be committed.

pub async fn transaction_with_config_async<F, T, E>( &self, callback: F, isolation_level: Option<IsolationLevel>, access_mode: Option<AccessMode>, ) -> Result<T, TransactionError<E>>

where F: for<'c> AsyncFnOnce(&'c DatabaseTransaction) -> Result<T, E> + Send, T: Send, E: Display + Debug + Send,

Execute the function inside a transaction with isolation level and/or access mode. If the function returns an error, the transaction will be rolled back. Otherwise, the transaction will be committed.

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

Commit a transaction

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

Rolls back a transaction explicitly

Trait Implementations

impl Connection for DatabaseTransaction

fn query_all<'life0, 'async_trait>( &'life0 self, select: SelectStatement, ) -> Pin<Box<dyn Future<Output = Result<Vec<SqlxRow>, Error>> + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

fn query_all_raw<'life0, 'async_trait>( &'life0 self, sql: String, ) -> Pin<Box<dyn Future<Output = Result<Vec<SqlxRow>, Error>> + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

impl ConnectionTrait for DatabaseTransaction

fn get_database_backend(&self) -> DatabaseBackend

Get the database backend for the connection. This depends on feature flags enabled.

fn execute_raw<'life0, 'async_trait>( &'life0 self, stmt: Statement, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

Execute a Statement

fn execute_unprepared<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, DatabaseTransaction: 'async_trait,

Execute a unprepared Statement

fn query_one_raw<'life0, 'async_trait>( &'life0 self, stmt: Statement, ) -> Pin<Box<dyn Future<Output = Result<Option<QueryResult>, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

Execute a Statement and return a single row of QueryResult

fn query_all_raw<'life0, 'async_trait>( &'life0 self, stmt: Statement, ) -> Pin<Box<dyn Future<Output = Result<Vec<QueryResult>, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

Execute a Statement and return a vector of QueryResult

fn execute<'life0, 'life1, 'async_trait, S>( &'life0 self, stmt: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, S: 'async_trait + StatementBuilder, Self: 'async_trait,

Execute a [QueryStatement]

fn query_one<'life0, 'life1, 'async_trait, S>( &'life0 self, stmt: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Option<QueryResult>, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, S: 'async_trait + StatementBuilder, Self: 'async_trait,

Execute a [QueryStatement] and return a single row of QueryResult

fn query_all<'life0, 'life1, 'async_trait, S>( &'life0 self, stmt: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Vec<QueryResult>, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, S: 'async_trait + StatementBuilder, Self: 'async_trait,

Execute a [QueryStatement] and return a vector of QueryResult

fn support_returning(&self) -> bool

Check if the connection supports RETURNING syntax on insert and update

fn is_mock_connection(&self) -> bool

Check if the connection is a test connection for the Mock database

impl Debug for DatabaseTransaction

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

Formats the value using the given formatter.

impl Drop for DatabaseTransaction

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<'c> From<&'c DatabaseTransaction> for DatabaseExecutor<'c>

fn from(trans: &'c DatabaseTransaction) -> DatabaseExecutor<'c>

Converts to this type from the input type.

impl<'c> IntoDatabaseExecutor<'c> for &'c DatabaseTransaction

fn into_database_executor(self) -> DatabaseExecutor<'c>

Convert into a DatabaseExecutor

impl IntoDatabaseExecutor<'static> for DatabaseTransaction

fn into_database_executor(self) -> DatabaseExecutor<'static>

Convert into a DatabaseExecutor

impl StreamTrait for DatabaseTransaction

type Stream<'a> = TransactionStream<'a>

Create a stream for the QueryResult

fn get_database_backend(&self) -> DatabaseBackend

Get the database backend for the connection. This depends on feature flags enabled.

fn stream_raw<'a>( &'a self, stmt: Statement, ) -> Pin<Box<dyn Future<Output = Result<<DatabaseTransaction as StreamTrait>::Stream<'a>, DbErr>> + Send + 'a>>

Execute a Statement and return a stream of results

fn stream<'a, S>( &'a self, stmt: &S, ) -> Pin<Box<dyn Future<Output = Result<Self::Stream<'a>, DbErr>> + Send + 'a>>

where S: StatementBuilder + Sync,

Execute a [QueryStatement] and return a stream of results

impl TransactionSession for DatabaseTransaction

fn commit<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>

where DatabaseTransaction: 'async_trait,

Commit a transaction

fn rollback<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>

where DatabaseTransaction: 'async_trait,

Rolls back a transaction explicitly

impl TransactionTrait for DatabaseTransaction

fn transaction<'life0, 'async_trait, F, T, E>( &'life0 self, _callback: F, ) -> Pin<Box<dyn Future<Output = Result<T, TransactionError<E>>> + Send + 'async_trait>>

where 'life0: 'async_trait, F: for<'c> FnOnce(&'c DatabaseTransaction) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'c>> + Send + 'async_trait, T: Send + 'async_trait, E: Display + Debug + Send + 'async_trait, DatabaseTransaction: 'async_trait,

Execute the async function inside a transaction. If the function returns an error, the transaction will be rolled back. Otherwise, the transaction will be committed.

fn transaction_with_config<'life0, 'async_trait, F, T, E>( &'life0 self, _callback: F, isolation_level: Option<IsolationLevel>, access_mode: Option<AccessMode>, ) -> Pin<Box<dyn Future<Output = Result<T, TransactionError<E>>> + Send + 'async_trait>>

where 'life0: 'async_trait, F: for<'c> FnOnce(&'c DatabaseTransaction) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'c>> + Send + 'async_trait, T: Send + 'async_trait, E: Display + Debug + Send + 'async_trait, DatabaseTransaction: 'async_trait,

Execute the async function inside a transaction. If the function returns an error, the transaction will be rolled back. Otherwise, the transaction will be committed.

type Transaction = DatabaseTransaction

The concrete type for the transaction

fn begin<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DatabaseTransaction, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

Execute SQL BEGIN transaction. Returns a Transaction that can be committed or rolled back

fn begin_with_config<'life0, 'async_trait>( &'life0 self, isolation_level: Option<IsolationLevel>, access_mode: Option<AccessMode>, ) -> Pin<Box<dyn Future<Output = Result<DatabaseTransaction, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

Execute SQL BEGIN transaction with isolation level and/or access mode. Returns a Transaction that can be committed or rolled back

fn begin_with_options<'life0, 'async_trait>( &'life0 self, options: TransactionOptions, ) -> Pin<Box<dyn Future<Output = Result<DatabaseTransaction, DbErr>> + Send + 'async_trait>>

where 'life0: 'async_trait, DatabaseTransaction: 'async_trait,

Execute SQL BEGIN transaction with isolation level and/or access mode. Returns a Transaction that can be committed or rolled back