Start a new client session for use with this client

Description

final public MongoDB\Driver\Session MongoDB\Driver\Manager::startSession ([ array $options ] )

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

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

Parameters

options

Option Type Description Default

causalConsistency

boolean

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.

TRUE

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.

**options**
Option	Type	Description
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+.

[]

Return Values

Returns a MongoDB\Driver\Session.

Errors/Exceptions

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Throws MongoDB\Driver\Exception\RuntimeException if the session could not be created (e.g. libmongoc does not support crypto).

Changelog

Version	Description
1.5.0	The "defaultTransactionOptions" option was added.

MongoDB\Driver\Manager::startSession

Description

Parameters

Return Values

Errors/Exceptions

Changelog

See Also