/ /

/ /

MongoDB$Client::getCollection()

定義

MongoDB\Client::getCollection()

サーバー上のコレクションにアクセスします。このメソッドは MongoDB\Client::selectCollection() のエイリアスであり、将来のリリースで置き換えられます。

function getCollection(
    string $databaseName,
    string $collectionName,
    array $options = []
): MongoDB\Collection

パラメーター

$databaseName : string

アクセスするコレクションを含むデータベースの名前。

$collectionName : string

アクセスするコレクションの名前。

$options : 配列

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

名前	タイプ	説明
コーデック	MongoDB\Codec\DocumentCodec	コレクション操作に使用するデフォルトのタイプコーデックでデータをエンコードする。バージョン 1.17 の新機能。
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\Collectionオブジェクト。

エラーと例外

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

動作

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

例

次の例では、testデータベース内の usersコレクションにアクセスします。

<?php
$client = new MongoDB\Client;
$collection = $client->getCollection('test', 'users');

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

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

その他の参照

戻る

dropDatabase()

getDatabase()