Struct Lock

pub struct Lock<C>
where
    C: ConnectionTrait + Debug,
{ /* private fields */ }

Lock entity

Implementations

impl<C> Lock<C>

where C: ConnectionTrait + Debug,

pub async fn build<S>( key: S, conn: C, timeout: Option<u8>, ) -> Result<Lock<C>, Lock<C>>

where S: Into<String> + Debug,

Lock builder Takes anything can become a String as key, an owned connection (it can be a sea_orm::DatabaseConnection, a sea_orm::DatabaseTransaction or another Lock` himself), and an optional timeout in seconds, defaulting to 1 second

pub fn get_key(&self) -> &str

returns locked key

pub async fn release(self) -> Result<C, Unlock<C>>

releases the lock, returning the owned connection on success on error it will return the Lock himself alongside with the database error, if any

pub fn into_inner(self) -> C

forgets the lock and returns inner connection WARNING: the lock will continue to live in the database session

Trait Implementations

impl<C> ConnectionTrait for Lock<C>

where C: ConnectionTrait + Debug + Send,

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 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<C> Debug for Lock<C>

where C: ConnectionTrait + Debug + Debug,

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

Formats the value using the given formatter.

impl<C> Drop for Lock<C>

where C: ConnectionTrait + Debug,

fn drop(&mut self)

Executes the destructor for this type.

impl<C> StreamTrait for Lock<C>

where C: ConnectionTrait + StreamTrait + Debug,

type Stream<'a> = <C as StreamTrait>::Stream<'a> where Self: 'a

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<C> TransactionTrait for Lock<C>

where C: ConnectionTrait + TransactionTrait + Debug + Send,

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 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 with isolation level and/or access mode. If the function returns an error, the transaction will be rolled back. If it does not return an error, the transaction will be committed.