use crate::{ DatabaseTransaction, DbBackend, DbErr, ExecResult, QueryResult, Statement, TransactionError, }; use futures::Stream; use std::{future::Future, pin::Pin}; /// Creates constraints for any structure that can create a database connection /// and execute SQL statements #[async_trait::async_trait] pub trait ConnectionTrait: Sync { /// Fetch the database backend as specified in [DbBackend]. /// This depends on feature flags enabled. fn get_database_backend(&self) -> DbBackend; /// Execute a [Statement] async fn execute(&self, stmt: Statement) -> Result; /// Execute a [Statement] and return a query async fn query_one(&self, stmt: Statement) -> Result, DbErr>; /// Execute a [Statement] and return a collection Vec<[QueryResult]> on success async fn query_all(&self, stmt: Statement) -> Result, DbErr>; /// Check if the connection supports `RETURNING` syntax on insert and update fn support_returning(&self) -> bool { let db_backend = self.get_database_backend(); db_backend.support_returning() } /// Check if the connection is a test connection for the Mock database fn is_mock_connection(&self) -> bool { false } } /// Stream query results #[async_trait::async_trait] pub trait StreamTrait<'a>: Send + Sync { /// Create a stream for the [QueryResult] type Stream: Stream> + Send; /// Execute a [Statement] and return a stream of results fn stream( &'a self, stmt: Statement, ) -> Pin> + 'a + Send>>; } /// Spawn database transaction #[async_trait::async_trait] pub trait TransactionTrait { /// Execute SQL `BEGIN` transaction. /// Returns a Transaction that can be committed or rolled back async fn begin(&self) -> Result; /// 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. async fn transaction(&self, callback: F) -> Result> where F: for<'c> FnOnce( &'c DatabaseTransaction, ) -> Pin> + Send + 'c>> + Send, T: Send, E: std::error::Error + Send; }