Enum DatabaseExecutor 

pub enum DatabaseExecutor<'c> {
    Connection(&'c DatabaseConnection),
    Transaction(&'c DatabaseTransaction),
    OwnedTransaction(DatabaseTransaction),
}

Either a borrowed DatabaseConnection / DatabaseTransaction, or an owned DatabaseTransaction.

Implements ConnectionTrait and TransactionTrait, so APIs that need to accept “any of those three” can take a DatabaseExecutor and not worry about which variant the caller had. Used in particular by sea-orm-migration’s SchemaManager.

Variants

Connection(&'c DatabaseConnection)

Borrowed connection — use against a long-lived pool.

Transaction(&'c DatabaseTransaction)

Borrowed transaction — caller still owns the transaction handle.

OwnedTransaction(DatabaseTransaction)

Owned transaction — used by migration’s SchemaManager::begin() so the transaction can be committed/rolled back at the end of the call.

Implementations

impl DatabaseExecutor<'_>

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 fn is_transaction(&self) -> bool

Returns true if this executor is backed by a transaction (borrowed or owned).

pub fn get_schema_builder(&self) -> SchemaBuilder

Creates a SchemaBuilder for this backend

Trait Implementations

impl Connection for DatabaseExecutor<'_>

Available on crate features schema-sync and sqlx-dep only.

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

where Self: 'async_trait, 'life0: 'async_trait,

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

where Self: 'async_trait, 'life0: 'async_trait,

impl ConnectionTrait for DatabaseExecutor<'_>

fn get_database_backend(&self) -> DbBackend

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 Self: 'async_trait, 'life0: '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 Self: 'async_trait, 'life0: 'async_trait, 'life1: '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 Self: 'async_trait, 'life0: '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 Self: 'async_trait, 'life0: '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 S: 'async_trait + StatementBuilder, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute a StatementBuilder

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 S: 'async_trait + StatementBuilder, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute a StatementBuilder 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 S: 'async_trait + StatementBuilder, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute a StatementBuilder 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<'c> Debug for DatabaseExecutor<'c>

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

Formats the value using the given formatter.

impl<'c> From<&'c DatabaseConnection> for DatabaseExecutor<'c>

fn from(conn: &'c DatabaseConnection) -> Self

Converts to this type from the input type.

impl<'c> From<&'c DatabaseTransaction> for DatabaseExecutor<'c>

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

Converts to this type from the input type.

impl<'c> IntoDatabaseExecutor<'c> for DatabaseExecutor<'c>

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

Build the DatabaseExecutor.

impl TransactionTrait for DatabaseExecutor<'_>

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 Self: 'async_trait, 'life0: '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 Self: 'async_trait, 'life0: '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 Self: 'async_trait, 'life0: 'async_trait,

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

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 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, Self: 'async_trait, 'life0: 'async_trait,

Execute the function inside a transaction. If the function returns an error, the transaction will be rolled back. If it does not return an error, 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 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, Self: 'async_trait, 'life0: 'async_trait,

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. If it does not return an error, the transaction will be committed.