Struct ClientSession

pub struct ClientSession { /* private fields */ }

A MongoDB client session. This struct represents a logical session used for ordering sequential operations. To create a ClientSession, call start_session on a Client.

ClientSession instances are not thread safe or fork safe. They can only be used by one thread or process at a time.

Transactions

Transactions are used to execute a series of operations across multiple documents and collections atomically. For more information about when and how to use transactions in MongoDB, see the manual.

Replica set transactions are supported on MongoDB 4.0+. Sharded transactions are supported on MongoDDB 4.2+. Transactions are associated with a ClientSession. To begin a transaction, call ClientSession::start_transaction on a ClientSession. The ClientSession must be passed to operations to be executed within the transaction.

use mongodb::{
    bson::{doc, Document},
    error::{Result, TRANSIENT_TRANSACTION_ERROR, UNKNOWN_TRANSACTION_COMMIT_RESULT},
    options::{Acknowledgment, ReadConcern, TransactionOptions, WriteConcern},
    ClientSession,
    Collection,
};

let mut session = client.start_session().await?;
session
    .start_transaction()
    .read_concern(ReadConcern::majority())
    .write_concern(WriteConcern::majority())
    .await?;
// A "TransientTransactionError" label indicates that the entire transaction can be retried
// with a reasonable expectation that it will succeed.
while let Err(error) = execute_transaction(&coll, &mut session).await {
    if !error.contains_label(TRANSIENT_TRANSACTION_ERROR) {
        break;
    }
}

async fn execute_transaction(coll: &Collection<Document>, session: &mut ClientSession) -> Result<()> {
    coll.insert_one(doc! { "x": 1 }).session(&mut *session).await?;
    coll.delete_one(doc! { "y": 2 }).session(&mut *session).await?;
    // An "UnknownTransactionCommitResult" label indicates that it is unknown whether the
    // commit has satisfied the write concern associated with the transaction. If an error
    // with this label is returned, it is safe to retry the commit until the write concern is
    // satisfied or an error without the label is returned.
    loop {
        let result = session.commit_transaction().await;
        if let Err(ref error) = result {
            if error.contains_label(UNKNOWN_TRANSACTION_COMMIT_RESULT) {
                continue;
            }
        }
        result?
    }
}

Implementations

impl ClientSession

pub fn start_transaction(&mut self) -> StartTransaction<&mut Self>

Starts a new transaction on this session. If no options are set, the session’s defaultTransactionOptions will be used. This session must be passed into each operation within the transaction; otherwise, the operation will be executed outside of the transaction.

Errors returned from operations executed within a transaction may include a crate::error::TRANSIENT_TRANSACTION_ERROR label. This label indicates that the entire transaction can be retried with a reasonable expectation that it will succeed.

Transactions on replica sets are supported on MongoDB 4.0+. Transactions on sharded clusters are supported on MongoDB 4.2+.

session.start_transaction().await?;
let result = coll.insert_one(doc! { "x": 1 }).session(&mut session).await?;
session.commit_transaction().await?;

await will return [Result<()>].

These methods can be chained before .await to set options:

• with_options
• read_concern
• write_concern
• selection_criteria
• max_commit_time

pub fn commit_transaction(&mut self) -> CommitTransaction<'_>

Commits the transaction that is currently active on this session.

This method may return an error with a crate::error::UNKNOWN_TRANSACTION_COMMIT_RESULT label. This label indicates that it is unknown whether the commit has satisfied the write concern associated with the transaction. If an error with this label is returned, it is safe to retry the commit until the write concern is satisfied or an error without the label is returned.

session.start_transaction().await?;
let result = coll.insert_one(doc! { "x": 1 }).session(&mut session).await?;
session.commit_transaction().await?;

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

await will return [Result<()>].

pub fn abort_transaction(&mut self) -> AbortTransaction<'_>

Aborts the transaction that is currently active on this session. Any open transaction will be aborted automatically in the Drop implementation of ClientSession.

session.start_transaction().await?;
match execute_transaction(&coll, &mut session).await {
    Ok(_) => session.commit_transaction().await?,
    Err(_) => session.abort_transaction().await?,
}

async fn execute_transaction(coll: &Collection<Document>, session: &mut ClientSession) -> Result<()> {
    coll.insert_one(doc! { "x": 1 }).session(&mut *session).await?;
    coll.delete_one(doc! { "y": 2 }).session(&mut *session).await?;
    Ok(())
}

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

await will return [Result<()>].

impl ClientSession

pub fn client(&self) -> Client

The client used to create this session.

pub fn id(&self) -> &Document

The id of this session.

pub fn cluster_time(&self) -> Option<&ClusterTime>

The highest seen cluster time this session has seen so far. This will be None if this session has not been used in an operation yet.

pub fn advance_cluster_time(&mut self, to: &ClusterTime)

Set the cluster time to the provided one if it is greater than this session’s highest seen cluster time or if this session’s cluster time is None.

pub fn advance_operation_time(&mut self, ts: Timestamp)

Advance operation time for this session. If the provided timestamp is earlier than this session’s current operation time, then the operation time is unchanged.

pub fn operation_time(&self) -> Option<Timestamp>

The operation time returned by the last operation executed in this session.

Trait Implementations

impl Debug for ClientSession

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

Formats the value using the given formatter.

impl Drop for ClientSession

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a mut ClientSession> for &'a mut ClientSession

Available on crate feature sync only.

fn from(value: &'a mut ClientSession) -> &'a mut AsyncClientSession

Converts to this type from the input type.

impl From<ClientSession> for ClientSession

Available on crate feature sync only.

fn from(async_client_session: AsyncClientSession) -> Self

Converts to this type from the input type.