MongoDB\Driver\Manager::startSession
(mongodb >=1.4.0)
MongoDB\Driver\Manager::startSession — Start a new client session for use with this client
Beschreibung
Creates a MongoDB\Driver\Session for the given options. The session may then be specified when executing commands, queries, and write operations.
Hinweis: A MongoDB\Driver\Session can only be used with the MongoDB\Driver\Manager from which it was created.
Parameter-Liste
-
options -
options 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 tofalseto disable causal consistency.See » Casual Consistency in the MongoDB manual for more information.
truedefaultTransactionOptions 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.
options Option Type Description maxCommitTimeMS integer Die maximale Dauer in Millisekunden, die ein einziger
commitTransaction-Befehl beanspruchen darf.Wenn angegeben, muss
maxCommitTimeMSeine vorzeichenbehaftete 32-bit Ganzzahl größer als oder gleich Null sein.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 unshardeddistinct). Subsequent read operations within the session will then utilize a"snapshot"read concern level to read majority-committed data from that timestamp. Set tofalseto disable snapshot reads.Snapshot reads require MongoDB 5.0+ and cannot be used with causal consistency, transactions, or write operations. If
"snapshot"istrue,"causalConsistency"will default tofalse.See » Read Concern "snapshot" in the MongoDB manual for more information.
false
Rückgabewerte
Returns a MongoDB\Driver\Session.
Fehler/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\InvalidArgumentException if the
"causalConsistency"and"snapshot"options are bothtrue. - Throws MongoDB\Driver\Exception\RuntimeException if the session could not be created (e.g. libmongoc does not support crypto).
Changelog
| Version | Beschreibung |
|---|---|
| PECL mongodb 1.11.0 |
The |
| PECL mongodb 1.6.0 |
The |
| PECL mongodb 1.5.0 |
The |
Siehe auch
- MongoDB\Driver\Session
- » Casual Consistency in the MongoDB manual

