Skip to main content

Transaction

Struct Transaction 

Source
pub struct Transaction { /* private fields */ }
Expand description

Transaction guard for automatic commit/rollback

This wrapper around SQLx transactions provides:

  • Automatic commit on drop (if not already committed/rolled back)
  • Explicit commit and rollback methods
  • Prevents accidental use after commit/rollback

§Example

use ormkit::transaction::Transaction;

let mut tx = Transaction::begin(pool).await?;

// Perform operations
sqlx::query("INSERT INTO users (name) VALUES ($1)")
    .bind("John")
    .execute(&mut *tx)
    .await?;

// Explicitly commit
tx.commit().await?;

Implementations§

Source§

impl Transaction

Source

pub async fn begin(pool: &PgPool) -> TransactionResult<Self>

Begin a new transaction

§Arguments
  • pool - The database connection pool
§Returns

A new transaction guard

Source

pub async fn begin_with_isolation( pool: &PgPool, isolation_level: IsolationLevel, ) -> TransactionResult<Self>

Begin a transaction with a specific isolation level

§Arguments
  • pool - The database connection pool
  • isolation_level - The isolation level to use
§Returns

A new transaction guard

Source

pub async fn commit(self) -> TransactionResult<()>

Commit the transaction

§Returns

Ok on success, Err if already committed or rolled back

Source

pub async fn rollback(self) -> TransactionResult<()>

Rollback the transaction

§Returns

Ok on success, Err if already committed or rolled back

Source

pub async fn savepoint(&mut self, _name: &str) -> TransactionResult<()>

Create a savepoint within this transaction

§Arguments
  • name - The name for the savepoint
§Returns

A savepoint guard

§Note

Savepoints are not currently supported by SQLx’s public API. This method is a placeholder for future implementation.

Source

pub fn is_active(&self) -> bool

Check if the transaction is still active

Source

pub fn is_committed(&self) -> bool

Check if the transaction has been committed

Source

pub fn is_rolled_back(&self) -> bool

Check if the transaction has been rolled back

Trait Implementations§

Source§

impl Deref for Transaction

Source§

type Target = Transaction<'static, Postgres>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl DerefMut for Transaction

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl Drop for Transaction

Auto-commit on drop if not already committed/rolled back

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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> 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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