Enum DatabaseConnection 

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

Handle a database connection depending on the backend enabled by the feature flags. This creates a database pool. This will be Clone unless the feature flag mock is enabled.

Variants

SqlxMySqlPoolConnection(SqlxMySqlPoolConnection)

Available on crate feature sqlx-mysql only.

Create a MYSQL database connection and pool

SqlxPostgresPoolConnection(SqlxPostgresPoolConnection)

Available on crate feature sqlx-postgres only.

Create a PostgreSQL database connection and pool

SqlxSqlitePoolConnection(SqlxSqlitePoolConnection)

Available on crate feature sqlx-sqlite only.

Create a SQLite database connection and pool

MockDatabaseConnection(Arc<MockDatabaseConnection>)

Available on crate feature mock only.

Create a Mock database connection useful for testing

ProxyDatabaseConnection(Arc<ProxyDatabaseConnection>)

Available on crate feature proxy only.

Create a Proxy database connection useful for proxying

Disconnected

The connection to the database has been severed

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 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 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 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<'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 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 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: 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.

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