Transaction

Struct Transaction 

Source
pub struct Transaction<'a> { /* private fields */ }
Expand description

A wrapper around a SQLx transaction.

Provides a way to execute multiple queries atomically. If any query fails, the transaction can be rolled back. If all succeed, it can be committed.

§Type Parameters

  • 'a - The lifetime of the database connection source

§Fields

  • tx - The underlying SQLx transaction
  • driver - The database driver type (for query syntax handling)

Implementations§

Source§

impl<'a> Transaction<'a>

Source

pub fn model<T: Model + Send + Sync + Unpin>( &mut self, ) -> QueryBuilder<'a, T, &mut Transaction<'a, Any>>

Starts building a query within this transaction.

This method creates a new QueryBuilder that will execute its queries as part of this transaction.

§Type Parameters
  • T - The Model type to query.
§Returns

A new QueryBuilder instance bound to this transaction.

§Example
let mut tx = db.begin().await?;

// These operations are part of the transaction
tx.model::<User>().insert(&user).await?;
tx.model::<Post>().insert(&post).await?;

tx.commit().await?;
Source

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

Commits the transaction.

Persists all changes made during the transaction to the database. This consumes the Transaction instance.

§Returns
  • Ok(()) - Transaction committed successfully
  • Err(sqlx::Error) - Database error during commit
Source

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

Rolls back the transaction.

Reverts all changes made during the transaction. This happens automatically if the Transaction is dropped without being committed, but this method allows for explicit rollback.

§Returns
  • Ok(()) - Transaction rolled back successfully
  • Err(sqlx::Error) - Database error during rollback

Trait Implementations§

Source§

impl<'a, 'b> Connection for &'a mut Transaction<'b>

Implementation of Connection for a mutable reference to Transaction.

Source§

type Exec<'c> = &'c mut AnyConnection where Self: 'c

The type of the executor returned by this connection. Read more
Source§

fn executor<'c>(&'c mut self) -> Self::Exec<'c>

Returns a mutable reference to the SQLx executor. Read more
Source§

impl<'a> Connection for Transaction<'a>

Implementation of Connection for a Transaction.

Allows the QueryBuilder to use a transaction for executing queries. Supports generic borrow lifetimes to allow multiple operations within the same transaction scope.

Source§

type Exec<'c> = &'c mut AnyConnection where Self: 'c

The type of the executor returned by this connection. Read more
Source§

fn executor<'c>(&'c mut self) -> Self::Exec<'c>

Returns a mutable reference to the SQLx executor. Read more
Source§

impl<'a> Debug for Transaction<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Transaction<'a>

§

impl<'a> !RefUnwindSafe for Transaction<'a>

§

impl<'a> Send for Transaction<'a>

§

impl<'a> !Sync for Transaction<'a>

§

impl<'a> Unpin for Transaction<'a>

§

impl<'a> !UnwindSafe for Transaction<'a>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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

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