Struct DatabaseConnection 

#[non_exhaustive]
pub struct DatabaseConnection {
    pub inner: DatabaseConnectionType,
}

Handle a database connection depending on the backend enabled by the feature flags. This creates a connection pool internally (for SQLx connections), and so is cheap to clone.

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

DatabaseConnection used to be a enum. Now it’s moved into inner, because we have to attach other contexts.

Implementations

impl DatabaseConnection

pub fn get_database_backend(&self) -> DatabaseBackend

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_postgres_connection_pool(&self) -> &Pool<Postgres>

Get sqlx::PgPool

Panics

Panics if DbConn is not a Postgres 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 ConnectionCacheExt for &DatabaseConnection

fn with_query_cache(self) -> CachedConnection

Wrap this connection with query result caching.

impl ConnectionCacheExt for DatabaseConnection

fn with_query_cache(self) -> CachedConnection

Wrap this connection with query result caching.

impl ConnectionTrait for DatabaseConnection

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, DatabaseConnection: '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, DatabaseConnection: '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, DatabaseConnection: '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, DatabaseConnection: '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 DatabaseConnection

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

Formats the value using the given formatter.

impl Default for DatabaseConnection

fn default() -> DatabaseConnection

Returns the “default value” for a type.

impl From<DatabaseConnectionType> for DatabaseConnection

fn from(inner: DatabaseConnectionType) -> DatabaseConnection

Converts to this type from the input type.

impl From<Pool<Postgres>> for DatabaseConnection

fn from(pool: Pool<Postgres>) -> DatabaseConnection

Converts to this type from the input type.

impl StreamTrait for DatabaseConnection

type Stream<'a> = QueryStream

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

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