Enum sea_orm::entity::prelude::DatabaseConnection

pub enum DatabaseConnection {
    SqlxMySqlPoolConnection(SqlxMySqlPoolConnection),
    SqlxPostgresPoolConnection(SqlxPostgresPoolConnection),
    SqlxSqlitePoolConnection(SqlxSqlitePoolConnection),
    MockDatabaseConnection(Arc<MockDatabaseConnection>),
    Disconnected,
}

Handle a database connection depending on the backend enabled by the feature flags. This creates a database pool.

Variants

SqlxMySqlPoolConnection(SqlxMySqlPoolConnection)

Create a MYSQL database connection and pool

SqlxPostgresPoolConnection(SqlxPostgresPoolConnection)

Create a PostgreSQL database connection and pool

SqlxSqlitePoolConnection(SqlxSqlitePoolConnection)

Create a SQLite database connection and pool

MockDatabaseConnection(Arc<MockDatabaseConnection>)

Create a Mock database connection useful for testing

Disconnected

The connection to the database has been severed

Implementations

impl DatabaseConnection

pub fn as_mock_connection(&self) -> &MockDatabaseConnection

Generate a database connection for testing the Mock database

pub fn into_transaction_log(self) -> Vec<Transaction>

Get the transaction log as a collection Vec<crate::Transaction>

impl DatabaseConnection

pub fn set_metric_callback<F>(&mut self, _callback: F)where
    F: Fn(&Info<'_>) + Send + Sync + 'static,

Sets a callback to metric this connection

Trait Implementations

impl ConnectionTrait for DatabaseConnection

fn get_database_backend(&self) -> DbBackend

Fetch the database backend as specified in DbBackend. This depends on feature flags enabled.

fn execute<'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 query_one<'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 query

fn query_all<'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 collection Vec<QueryResult> on success

fn is_mock_connection(&self) -> bool

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

fn support_returning(&self) -> bool

Check if the connection supports RETURNING syntax on insert and update

impl Debug for DatabaseConnection

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

Formats the value using the given formatter.

impl Default for DatabaseConnection

fn default() -> Self

Returns the “default value” for a type.

impl StreamTrait for DatabaseConnection

type Stream<'a> = QueryStream

Create a stream for the QueryResult

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

Execute a Statement and return a stream of results

impl TransactionTrait for DatabaseConnection

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: Error + 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: Error + 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 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