Struct Transaction 

#[non_exhaustive]
pub struct Transaction<'a> { /* private fields */ }

An active transaction guard.

Created via Connection::transaction or Connection::transaction_with. The guard provides methods to execute queries within the transaction and to commit or rollback it.

Drop behaviour

Drop cannot perform async I/O. If the transaction is not explicitly committed or rolled back before it goes out of scope, the connection may be left in an idle-in-transaction state. Always call .commit().await or .rollback().await explicitly.

Implementations

impl<'a> Transaction<'a>

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

Commit the transaction.

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

Roll back the transaction.

pub fn is_failed(&self) -> bool

Returns true if the transaction is in a failed state.

pub async fn query(&mut self, sql: &str) -> Result<QueryResult>

Execute a query that returns rows, within the transaction.

pub async fn execute(&mut self, sql: &str) -> Result<ExecuteResult>

Execute a statement that does not return rows.

pub async fn query_one(&mut self, sql: &str) -> Result<Option<Row>>

Execute a query and return at most one row.

pub async fn query_params( &mut self, sql: &str, params: &[&dyn ToSql], ) -> Result<QueryResult>

Execute a parameterized query that returns rows.

pub async fn execute_params( &mut self, sql: &str, params: &[&dyn ToSql], ) -> Result<ExecuteResult>

Execute a parameterized statement that does not return rows.

pub async fn prepare(&mut self, sql: &str) -> Result<PreparedStatement>

Prepare a statement within the transaction.

pub async fn savepoint(&mut self, name: &str) -> Result<Savepoint<'_, 'a>>

Create a savepoint (nested transaction scope).

Only one Savepoint guard can be active at a time for a given Transaction because it holds a mutable borrow.

pub async fn copy_in(&mut self, sql: &str) -> Result<CopyIn<'_>>

Start a COPY IN operation within this transaction.

pub async fn copy_out(&mut self, sql: &str) -> Result<CopyOut<'_>>

Start a COPY OUT operation within this transaction.

Trait Implementations

impl<'a> Drop for Transaction<'a>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.