The MongoDB\Driver\Session class

(mongodb >=1.4.0)

Introduction

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 the session.

Class synopsis

final MongoDB\Driver\Session {
/* Constants */
const string TRANSACTION_NONE = none ;
const string TRANSACTION_STARTING = starting ;
const string TRANSACTION_IN_PROGRESS = in_progress ;
const string TRANSACTION_COMMITTED = committed ;
const string TRANSACTION_ABORTED = aborted ;
/* Methods */
final public abortTransaction ( void ) : void
final public advanceClusterTime ( array|object $clusterTime ) : void
final public advanceOperationTime ( MongoDB\BSON\TimestampInterface $operationTime ) : void
final public commitTransaction ( void ) : void
final private __construct ( void )
final public endSession ( void ) : void
final public getClusterTime ( void ) : object|null
final public getLogicalSessionId ( void ) : object
final public getOperationTime ( void ) : MongoDB\BSON\Timestamp|null
final public getServer ( void ) : MongoDB\Driver\Server|null
final public getTransactionOptions ( void ) : array|null
final public getTransactionState ( void ) : string
final public isInTransaction ( void ) : boolean
final public startTransaction ([ array $options ] ) : void
}

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.

Table of Contents