Struct mongodb::sync::ClientSession

pub struct ClientSession { /* private fields */ }

Available on crate feature sync only.

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.

Implementations

impl ClientSession

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

Starts a new transaction on this session with the given TransactionOptions. If no options are provided, 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.

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

run will return [Result<()>].

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

Commits the transaction that is currently active on this session.

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

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.

run 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().run()?;
match execute_transaction(coll, &mut session) {
    Ok(_) => session.commit_transaction().run()?,
    Err(_) => session.abort_transaction().run()?,
}

fn execute_transaction(coll: Collection<Document>, session: &mut ClientSession) -> Result<()> {
    coll.insert_one(doc! { "x": 1 }).session(&mut *session).run()?;
    coll.delete_one(doc! { "y": 2 }).session(&mut *session).run()?;
    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.

run 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.

Trait Implementations

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

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

Converts to this type from the input type.

impl From<ClientSession> for ClientSession

fn from(async_client_session: AsyncClientSession) -> Self

Converts to this type from the input type.