Navigation

MongoDB\Client::startSession()

New in version 1.3.

On this page

Definition

MongoDB\Client::startSession

Start a new client session for use with this client.

copy 
function startSession(array $options = []): MongoDB\Driver\Session

Refer to the MongoDB\Driver\Manager::startSession() extension reference for accepted options.

Return Values

A MongoDBDriverSession object.

Errors/Exceptions

MongoDB\Driver\Exception\InvalidArgumentException for errors related to the parsing of parameters or options at the driver level.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

Example

The following example starts a new session:

copy 
<?php

$client = new MongoDB\Client;

$session = $client->startSession();

var_dump($session);

The output would then resemble:

copy 
object(MongoDB\Driver\Session)#2043 (4) {
  ["logicalSessionId"]=>
  array(1) {
    ["id"]=>
    object(MongoDB\BSON\Binary)#225 (2) {
      ["data"]=>
      string(16) "................"
      ["type"]=>
      int(4)
    }
  }
  ["clusterTime"]=>
  NULL
  ["causalConsistency"]=>
  bool(true)
  ["operationTime"]=>
  NULL
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.