MongoDB\Client::getCollection()

定义

MongoDB\Client::getCollection()

获取对服务器上集合的访问权限。此方法是 MongoDB\Client::selectCollection() 的别名，将在未来发布中取代它。

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

参数

$databaseName ： 细绳

包含要访问权限的集合的数据库的名称。

$collectionName ： 细绳

要访问权限的集合的名称。

$options : array

指定所需选项的数组。

名称	类型	说明
编解码器	MongoDB\Codec\DocumentCodec	默认使用类型编解码器对数据进行编码以用于集合操作。 1.17版本新增。：
事务外的	MongoDB\Driver\ReadConcern	用于collection操作的默认读关注（read concern）。默认为客户端的读关注（read concern）。
readPreference	MongoDB\Driver\ReadPreference	用于collection操作的默认读取偏好（read preference）。默认为客户端的读取偏好（read preference）。
typeMap	阵列	用于collection操作的默认类型映射。默认为客户端的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	用于collection操作的默认写关注（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'),
    ]
);

另请参阅

• MongoDB\Collection::__construct()
• MongoDB\Database::getCollection()