MongoDB\Client::startSession()

バージョン 1.3 で追加。

定義

MongoDB\Client::startSession()

このクライアントで使用する新しいクライアントセッションを開始します。

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

パラメーター

$options : 配列: 必要なオプションを指定する配列。サポートされているオプションのリストについては、 MongoDB\Driver\Manager::startSession() 拡張ドキュメントを参照してください。

Return Values

MongoDB$Driver\Sessionオブジェクト。

エラーと例外

拡張レベルでのパラメータまたはオプションの解析に関連するエラーの場合は、 MongoDB\Driver\Exception\InvalidArメントException 。

拡張レベルのその他のエラー（例: 接続エラー）の場合は、 MongoDB\Driver\Exception\RuntimeException 。

例

次の例では、新しいセッションを開始します。

<?php
$client = new MongoDB\Client;
$session = $client->startSession();
var_dump($session);

出力は次のようになります。

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\Driver\Manager::startSession()
MongoDB マニュアルの因果整合性を参照してください

戻る

選択データベース()

watch()