php8.5
/
Download
Home/ Manual/ mongodb / driver/ The MongoDB\Driver\Session class

The MongoDB\Driver\Session class

Guide Edit on GitHub ✎

The MongoDB\Driver\Session class represents a client session and is returned by MongoDB\Driver\Manager::startSession. Commands, queries, and write operations may then be associated with the session.

Intro

The MongoDB\Driver\Session class represents a client session and is returned by MongoDB\Driver\Manager::startSession. Commands, queries, and write operations may then be associated with the session.

Class synopsis

class MongoDB\Driver\Session { }

Predefined Constants

MongoDB\Driver\Session::TRANSACTION_NONE

There is no transaction in progress.

MongoDB\Driver\Session::TRANSACTION_STARTING

A transaction has been started, but no operation has been sent to the server.

MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS

A transaction is in progress.

MongoDB\Driver\Session::TRANSACTION_COMMITTED

The transaction was committed.

MongoDB\Driver\Session::TRANSACTION_ABORTED

The transaction was aborted.

Session

In this section

MongoDB\Driver\Session::__construct

Create a new Session (not used)

MongoDB\Driver\Session::abortTransaction

Aborts a transaction

MongoDB\Driver\Session::advanceClusterTime

Advances the cluster time for this session

MongoDB\Driver\Session::advanceOperationTime

Advances the operation time for this session

MongoDB\Driver\Session::commitTransaction

Commits a transaction

MongoDB\Driver\Session::endSession

Terminates a session

MongoDB\Driver\Session::getClusterTime

Returns the cluster time for this session

MongoDB\Driver\Session::getLogicalSessionId

Returns the logical session ID for this session

MongoDB\Driver\Session::getOperationTime

Returns the operation time for this session

MongoDB\Driver\Session::getServer

Returns the server to which this session is pinned

MongoDB\Driver\Session::getTransactionOptions

Returns options for the currently running transaction

MongoDB\Driver\Session::getTransactionState

Returns the current transaction state for this session

MongoDB\Driver\Session::isDirty

Returns whether the session has been marked as dirty

MongoDB\Driver\Session::isInTransaction

Returns whether a multi-document transaction is in progress

MongoDB\Driver\Session::startTransaction

Starts a transaction

Source: reference/mongodb/mongodb/driver/session.xml · from the official PHP manual (php/doc-en)