MongoDB\Driver\Session::startTransaction

    (mongodb >=1.5.0)

    MongoDB\Driver\Session::startTransaction — Starts a transaction

    说明

    finalpublicMongoDB\Driver\Session::startTransaction(?array$options = null): void

    Starts a multi-document transaction associated with the session. At any given time, you can have at most one open transaction for a session. After starting a transaction, the session object must be passed to each operation via the "session" option (e.g. MongoDB\Driver\Manager::executeBulkWrite()) in order to associate that operation with the transaction.

    Transactions can be committed through MongoDB\Driver\Session::commitTransaction(), and aborted with MongoDB\Driver\Session::abortTransaction(). Transactions are also automatically aborted when the session is closed from garbage collection or by explicitly calling MongoDB\Driver\Session::endSession().

    参数

    options

    Options can be passed as argument to this method. Each element in this options array overrides the corresponding option from the "defaultTransactionOptions" option, if set when starting the session with MongoDB\Driver\Manager::startSession().

    options
    OptionTypeDescription
    maxCommitTimeMSinteger

    The maximum amount of time in milliseconds to allow a single commitTransaction command to run.

    If specified, maxCommitTimeMS must be a signed 32-bit integer greater than or equal to zero.

    readConcernMongoDB\Driver\ReadConcern

    A read concern to apply to the operation.

    This option is available in MongoDB 3.2+ and will result in an exception at execution time if specified for an older server version.

    readPreferenceMongoDB\Driver\ReadPreference

    A read preference to use for selecting a server for the operation.

    writeConcernMongoDB\Driver\WriteConcern

    A write concern to apply to the operation.

    返回值

    没有返回值。

    错误／异常

    更新日志

    版本说明
    PECL mongodb 1.6.0

    The "maxCommitTimeMS" option was added.

    参见

    To Top