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

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

§

ProxyDatabaseConnection(Arc<ProxyDatabaseConnection>)

Create a Proxy database connection useful for proxying

§

Disconnected

The connection to the database has been severed

Implementations§

source§

impl DatabaseConnection

source

pub fn as_mock_connection(&self) -> &MockDatabaseConnection

Generate a database connection for testing the Mock database

§Panics

Panics if DbConn is not a mock connection.

source

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

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

§Panics

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

source§

impl DatabaseConnection

source

pub fn as_proxy_connection(&self) -> &ProxyDatabaseConnection

Generate a database connection for testing the Proxy database

§Panics

Panics if DbConn is not a proxy connection.

source§

impl DatabaseConnection

source

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

Sets a callback to metric this connection

source

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

Checks if a connection to the database is still valid.

source

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

Explicitly close the database connection

source§

impl DatabaseConnection

source

pub fn get_mysql_connection_pool(&self) -> &MySqlPool

Available on crate feature sea-orm-internal only.

Get [sqlx::MySqlPool]

§Panics

Panics if DbConn is not a MySQL connection.

source

pub fn get_postgres_connection_pool(&self) -> &PgPool

Available on crate feature sea-orm-internal only.

Get [sqlx::PgPool]

§Panics

Panics if DbConn is not a Postgres connection.

source

pub fn get_sqlite_connection_pool(&self) -> &SqlitePool

Available on crate feature sea-orm-internal only.

Get [sqlx::SqlitePool]

§Panics

Panics if DbConn is not a SQLite connection.

Trait Implementations§

source§

impl ConnectionTrait for DatabaseConnection

source§

fn get_database_backend(&self) -> DbBackend

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

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
source§

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
source§

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
source§

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
source§

fn is_mock_connection(&self) -> bool

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

fn support_returning(&self) -> bool

Check if the connection supports RETURNING syntax on insert and update
source§

impl Debug for DatabaseConnection

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DatabaseConnection

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl StreamTrait for DatabaseConnection

§

type Stream<'a> = QueryStream

Create a stream for the QueryResult
source§

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
source§

impl TransactionTrait for DatabaseConnection

source§

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.

source§

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.

source§

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
source§

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more