Transaction

Struct Transaction 

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

A PostgreSQL transaction for the asynchronous connection.

This struct provides transaction control. The connection is passed to commit and rollback methods to execute the transaction commands.

Implementations§

Source§

impl Transaction

Source

pub async fn commit(self, conn: &mut Conn) -> Result<()>

Commit the transaction.

This consumes the transaction and sends a COMMIT statement to the server. The connection must be passed as an argument to execute the commit.

§Errors

Returns Error::InvalidUsage if the connection is not the same as the one that started the transaction.

Source

pub async fn rollback(self, conn: &mut Conn) -> Result<()>

Rollback the transaction.

This consumes the transaction and sends a ROLLBACK statement to the server. The connection must be passed as an argument to execute the rollback.

§Errors

Returns Error::InvalidUsage if the connection is not the same as the one that started the transaction.

Source

pub async fn exec_portal<S: IntoStatement, P: ToParams>( &self, conn: &mut Conn, statement: S, params: P, ) -> Result<NamedPortal<'_>>

Create a named portal for iterative row fetching within this transaction.

Named portals are safe to use within an explicit transaction because SYNC messages do not destroy them (only COMMIT/ROLLBACK does).

The statement can be either:

  • A &PreparedStatement returned from conn.prepare()
  • A raw SQL &str for one-shot execution
§Example
conn.transaction(|conn, tx| async move {
    let mut portal = tx.exec_portal(conn, &stmt, ()).await?;

    while !portal.is_complete() {
        let rows: Vec<(i32,)> = portal.execute_collect(conn, 100).await?;
        process(rows);
    }

    portal.close(conn).await?;
    tx.commit(conn).await
}).await?;
§Errors

Returns Error::InvalidUsage if the connection is not the same as the one that started the transaction.

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

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