Struct sqlx::Transaction

source ·
pub struct Transaction<'c, DB>
where DB: Database,
{ /* private fields */ }
Expand description

An in-progress database transaction or savepoint.

A transaction starts with a call to Pool::begin or Connection::begin.

A transaction should end with a call to commit or rollback. If neither are called before the transaction goes out-of-scope, rollback is called. In other words, rollback is called on drop if the transaction is still in-progress.

A savepoint is a special mark inside a transaction that allows all commands that are executed after it was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint.

Implementations§

source§

impl<'c, DB> Transaction<'c, DB>
where DB: Database,

source

pub async fn commit(self) -> Result<(), Error>

Commits this transaction or savepoint.

source

pub async fn rollback(self) -> Result<(), Error>

Aborts this transaction or savepoint.

Trait Implementations§

source§

impl<'c, 't> Acquire<'t> for &'t mut Transaction<'c, MySql>

§

type Database = MySql

§

type Connection = &'t mut <MySql as Database>::Connection

source§

fn acquire( self ) -> Pin<Box<dyn Future<Output = Result<<&'t mut Transaction<'c, MySql> as Acquire<'t>>::Connection, Error>> + Send + 't>>

source§

fn begin( self ) -> Pin<Box<dyn Future<Output = Result<Transaction<'t, MySql>, Error>> + Send + 't>>

source§

impl<'c, DB> Debug for Transaction<'c, DB>
where DB: Database,

source§

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

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

impl<'c, DB> Deref for Transaction<'c, DB>
where DB: Database,

§

type Target = <DB as Database>::Connection

The resulting type after dereferencing.
source§

fn deref(&self) -> &<Transaction<'c, DB> as Deref>::Target

Dereferences the value.
source§

impl<'c, DB> DerefMut for Transaction<'c, DB>
where DB: Database,

source§

fn deref_mut(&mut self) -> &mut <Transaction<'c, DB> as Deref>::Target

Mutably dereferences the value.
source§

impl<'c, DB> Drop for Transaction<'c, DB>
where DB: Database,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'c, 't> Executor<'t> for &'t mut Transaction<'c, MySql>

§

type Database = MySql

source§

fn fetch_many<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Stream<Item = Result<Either<<MySql as Database>::QueryResult, MySqlRow>, Error>> + Send + 'e>>
where 'q: 'e, 't: 'e, E: 'q + Execute<'q, <&'t mut Transaction<'c, MySql> as Executor<'t>>::Database>,

Execute multiple queries and return the generated results as a stream from each query, in a stream.
source§

fn fetch_optional<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Future<Output = Result<Option<MySqlRow>, Error>> + Send + 'e>>
where 'q: 'e, 't: 'e, E: 'q + Execute<'q, <&'t mut Transaction<'c, MySql> as Executor<'t>>::Database>,

Execute the query and returns at most one row.
source§

fn prepare_with<'e, 'q>( self, sql: &'q str, parameters: &'e [<<&'t mut Transaction<'c, MySql> as Executor<'t>>::Database as Database>::TypeInfo] ) -> Pin<Box<dyn Future<Output = Result<<<&'t mut Transaction<'c, MySql> as Executor<'t>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e>>
where 'q: 'e, 't: 'e,

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results. Read more
source§

fn execute<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the total number of rows affected.
source§

fn execute_many<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute multiple queries and return the rows affected from each query, in a stream.
source§

fn fetch<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the generated results as a stream.
source§

fn fetch_all<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row>, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return all the generated results, collected into a Vec.
source§

fn fetch_one<'e, 'q, E>( self, query: E ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and returns exactly one row.
source§

fn prepare<'e, 'q>( self, query: &'q str ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e,

Prepare the SQL query to inspect the type information of its parameters and results. Read more

Auto Trait Implementations§

§

impl<'c, DB> !RefUnwindSafe for Transaction<'c, DB>

§

impl<'c, DB> Send for Transaction<'c, DB>

§

impl<'c, DB> Sync for Transaction<'c, DB>
where <DB as Database>::Connection: Sync,

§

impl<'c, DB> Unpin for Transaction<'c, DB>
where <DB as Database>::Connection: Unpin,

§

impl<'c, DB> !UnwindSafe for Transaction<'c, DB>

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

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

source§

fn vzip(self) -> V