Struct DatabaseConnection 

#[non_exhaustive]
pub struct DatabaseConnection {
    pub inner: DatabaseConnectionType,
    /* private fields */
}

A handle to a database — implements ConnectionTrait and TransactionTrait so it works with every query and mutation method in SeaORM.

Behind the scenes this is a connection pool (for SQLx-backed drivers) or a shared connection (for rusqlite / mocks / proxies), so it is cheap to clone — pass &DbConn around or db.clone() into spawned tasks. Obtain one via Database::connect.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

inner: DatabaseConnectionType

Driver-specific connection or pool. Held in a field so we can attach orthogonal state (e.g. RBAC) alongside.

Implementations

impl DatabaseConnection

pub fn as_mock_connection(&self) -> &MockDatabaseConnection

Available on crate feature mock only.

Generate a database connection for testing the Mock database

Panics

Panics if DbConn is not a mock connection.

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

Available on crate feature mock only.

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

Panics

Panics if the mocker mutex is being held by another thread.

impl DatabaseConnection

pub fn as_proxy_connection(&self) -> &ProxyDatabaseConnection

Available on crate feature proxy only.

Generate a database connection for testing the Proxy database

Panics

Panics if DbConn is not a proxy connection.

impl DatabaseConnection

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

Available on crate feature rbac only.

Load RBAC data from the same database as this connection and setup RBAC engine. If the RBAC engine already exists, it will be replaced.

pub async fn load_rbac_from(&self, db: &DbConn) -> Result<(), DbErr>

Available on crate feature rbac only.

Load RBAC data from the given database connection and setup RBAC engine. This could be from another database.

pub fn replace_rbac(&self, engine: RbacEngine)

Available on crate feature rbac only.

Replace the internal RBAC engine.

pub fn restricted_for( &self, user_id: RbacUserId, ) -> Result<RestrictedConnection, DbErr>

Available on crate feature rbac only.

Create a restricted connection with access control specific for the user.

impl DatabaseConnection

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 get_database_backend(&self) -> DbBackend

Get the database backend for this connection

Panics

Panics if DatabaseConnection is Disconnected.

pub fn get_schema_builder(&self) -> SchemaBuilder

Creates a SchemaBuilder for this backend

pub fn set_metric_callback<F>(&mut self, _callback: F)

where F: Fn(&Info<'_>) + Send + Sync + 'static,

Sets a callback to metric this connection

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

Checks if a connection to the database is still valid.

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

Explicitly close the database connection. See Self::close_by_ref for usage with references.

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

Explicitly close the database connection

impl DatabaseConnection

pub fn get_mysql_connection_pool(&self) -> &MySqlPool

Available on crate feature sqlx-mysql only.

Get sqlx::MySqlPool

Panics

Panics if DbConn is not a MySQL connection.

pub fn get_postgres_connection_pool(&self) -> &PgPool

Available on crate feature sqlx-postgres only.

Get sqlx::PgPool

Panics

Panics if DbConn is not a Postgres connection.

pub fn get_sqlite_connection_pool(&self) -> &SqlitePool

Available on crate feature sqlx-sqlite only.

Get sqlx::SqlitePool

Panics

Panics if DbConn is not a SQLite connection.

Trait Implementations

impl Clone for DatabaseConnection

fn clone(&self) -> DatabaseConnection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Connection for DatabaseConnection

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>> + Send + '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>> + Send + 'async_trait>>

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

impl ConnectionTrait for DatabaseConnection

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

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

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

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

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

Converts to this type from the input type.

impl From<DatabaseConnectionType> for DatabaseConnection

fn from(inner: DatabaseConnectionType) -> Self

Converts to this type from the input type.

impl From<Pool<MySql>> for DatabaseConnection

Available on crate feature sqlx-mysql only.

fn from(pool: MySqlPool) -> Self

Converts to this type from the input type.

impl From<Pool<Postgres>> for DatabaseConnection

Available on crate feature sqlx-postgres only.

fn from(pool: PgPool) -> Self

Converts to this type from the input type.

impl From<Pool<Sqlite>> for DatabaseConnection

Available on crate feature sqlx-sqlite only.

fn from(pool: SqlitePool) -> Self

Converts to this type from the input type.

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

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

Build the DatabaseExecutor.

impl StreamTrait for DatabaseConnection

type Stream<'a> = QueryStream

Available on crate feature stream only.

Create a stream for the QueryResult

fn get_database_backend(&self) -> DbBackend

Available on crate feature stream only.

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<Self::Stream<'a>, DbErr>> + Send + 'a>>

Available on crate feature stream only.

Execute a Statement and return a stream of results

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

Available on crate feature stream only.

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