(mongodb >=1.4.0)

MongoDB\Driver\Manager::startSessionStart a new client session for use with this client


final public MongoDB\Driver\Manager::startSession(array $options = ?): MongoDB\Driver\Session

Creates a MongoDB\Driver\Session for the given options. The session may then be specified when executing commands, queries, and write operations.

注意: A MongoDB\Driver\Session can only be used with the MongoDB\Driver\Manager from which it was created.



Option Type Description Default
causalConsistency bool

Configure causal consistency in a session. If true, each operation in the session will be causally ordered after the previous read or write operation. Set to false to disable causal consistency.

See » Casual Consistency in the MongoDB manual for more information.

defaultTransactionOptions array

Default options to apply to newly created transactions. These options are used unless they are overridden when a transaction is started with different value for each option.

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.

This option is available in MongoDB 4.0+.

snapshot bool

Configure snapshot reads in a session. If true, a timestamp will be obtained from the first supported read operation in the session (i.e. find, aggregate, or unsharded distinct). Subsequent read operations within the session will then utilize a "snapshot" read concern level to read majority-committed data from that timestamp. Set to false to disable snapshot reads.

Snapshot reads require MongoDB 5.0+ and cannot be used with causal consistency, transactions, or write operations. If "snapshot" is true, "causalConsistency" will default to false.

See » Read Concern "snapshot" in the MongoDB manual for more information.



Returns a MongoDB\Driver\Session.

エラー / 例外


バージョン 説明
PECL mongodb 1.11.0

The "snapshot" option was added.

PECL mongodb 1.6.0

The "maxCommitTimeMS" option was added to "defaultTransactionOptions".

PECL mongodb 1.5.0

The "defaultTransactionOptions" option was added.


add a note add a note

User Contributed Notes

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