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

    finalclassMongoDB\Driver\Session {
    conststringTRANSACTION_NONE = none;
    conststringTRANSACTION_STARTING = starting;
    conststringTRANSACTION_IN_PROGRESS = in_progress;
    conststringTRANSACTION_COMMITTED = committed;
    conststringTRANSACTION_ABORTED = aborted;
    finalpublicabortTransaction(): void
    finalpublicadvanceClusterTime(array|object$clusterTime): void
    finalpublicadvanceOperationTime(MongoDB\BSON\TimestampInterface$operationTime): void
    finalpubliccommitTransaction(): void
    finalprivate__construct()
    finalpublicendSession(): void
    finalpublicgetClusterTime(): ?object
    finalpublicgetLogicalSessionId(): object
    finalpublicgetOperationTime(): ?MongoDB\BSON\Timestamp
    finalpublicgetServer(): ?MongoDB\Driver\Server
    finalpublicgetTransactionOptions(): ?array
    finalpublicgetTransactionState(): string
    finalpublicisDirty(): bool
    finalpublicisInTransaction(): bool
    finalpublicstartTransaction(?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

    To Top