/ /

/ /

MongoDB$Client::getDatabase()

定義

MongoDB\Client::getDatabase()

サーバー上のデータベースへのアクセス権を取得します。このメソッドは MongoDB\Client::selectDatabase() のエイリアスであり、将来のリリースで置き換えられます。

function getDatabase(
    string $databaseName,
    array $options = []
): MongoDB\Database

パラメーター

$databaseName : string

アクセスするデータベースの名前。

$options : 配列

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

名前	タイプ	説明
ReadConcern	MongoDB\Driver\ReadConcern	データベース操作に使用するデフォルトの読み取り保証 (read concern) です。クライアントの読み取り保証（read concern）にデフォルト設定されます。
readPreference	MongoDB\Driver\ReadPreference	データベース操作に使用するデフォルトの読み込み設定 (read preference) 。クライアントの読み込み設定（read preference）にデフォルト設定されます。
typeMap	配列	データベース操作に使用するデフォルトのタイプマップ。クライアントのタイプマップにデフォルト設定されます。
writeConcern	MongoDB\Driver\WriteConcern	データベース操作に使用するデフォルトの書込み保証 (write concern) です。クライアントの書込み保証 (write concern) のデフォルト値。

Return Values

MongoDB\Databaseオブジェクト。

エラーと例外

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

動作

選択したデータベースは、Clientオブジェクトから読み込み設定 (read preference)やタイプマッピングなどのオプションを継承します。$options パラメータを使用することで、オプションを上書きできます。

例

次の例では、testデータベースへのアクセスを取得します。

<?php
$client = new MongoDB\Client;
$db = $client->getDatabase('test');

次の例では、カスタム読み込み設定 (read preference)を使用して testデータベースにアクセスします。

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

その他の参照

戻る

getCollection()

getManager()