MongoDB\Database::withOptions()

項目一覧

定義

パラメーター
Return Values
エラーと例外
例
その他の参照

定義

MongoDB\Database::withOptions()

データベースオブジェクトのクローンを返しますが、オプションは異なります。

function withOptions(array $options = []): MongoDB\Database

パラメーター

$options : 配列

必要なオプションを指定する配列。

名前	タイプ	説明
ReadConcern	MongoDB\Driver\ReadConcern	データベース操作に使用するデフォルトの読み取り保証 (read concern) です。デフォルトは、元のデータベースの読み取り保証 (read concern) です。
readPreference	MongoDB\Driver\ReadPreference	データベース操作に使用するデフォルトの読み込み設定 (read preference) 。デフォルトでは、元のデータベースの読み込み設定（read preference）に設定されます。
typeMap	配列	型マップカーソルに適用される。これは、BSON ドキュメントが PHP 値に変換される方法を決定します。デフォルトは、元のデータベースのタイプマップです。
writeConcern	MongoDB\Driver\WriteConcern	データベース操作に使用するデフォルトの書込み保証 (write concern) です。デフォルトは、元のデータベースの書込み保証 (write concern) です。

Return Values

MongoDB\Databaseオブジェクト。

エラーと例外

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合はです。

例

次の例では、既存のデータベースオブジェクトを新しい読み込み設定（read preference）で複製します。

<?php
$db = (new MongoDB\Client)->test;
$newDb = $db->withOptions([
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

その他の参照

MongoDB\Database::__construct()

戻る

watch()

MongoDB\Collection