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 class 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
    final public advanceClusterTime(array|object $clusterTime): void
    final public advanceOperationTime(MongoDB\BSON\TimestampInterface $operationTime): void
    final public commitTransaction(): void
    final private __construct()
    final public endSession(): void
    final public getClusterTime(): ?object
    final public getLogicalSessionId(): object
    final public getOperationTime(): ?MongoDB\BSON\Timestamp
    final public getServer(): ?MongoDB\Driver\Server
    final public getTransactionOptions(): ?array
    final public getTransactionState(): string
    final public isDirty(): bool
    final public isInTransaction(): bool
    final public startTransaction(?array $options = null): 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

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top