PHP 8.1.0 Beta 1 available for testing

MongoDB\Driver\Session::startTransaction

(mongodb >=1.5.0)

MongoDB\Driver\Session::startTransactionStarts a transaction

説明

final public MongoDB\Driver\Session::startTransaction(array $options = ?): 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
Option Type Description
maxCommitTimeMS integer

commitTransaction コマンドが実行できる最大の時間をミリ秒単位で指定します

指定する場合、 maxCommitTimeMS は、符号付き32bit の整数より大きいか、0でなければなりません

readConcern MongoDB\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.

readPreference MongoDB\Driver\ReadPreference

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

writeConcern MongoDB\Driver\WriteConcern

A write concern to apply to the operation.

返り値

値を返しません。

エラー / 例外

変更履歴

バージョン 説明
PECL mongodb 1.6.0

The "maxCommitTimeMS" option was added.

参考

add a note add a note

User Contributed Notes

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