MongoDB\Client::selectCollection()

本页内容

定义

参数
返回值
错误/异常
行为
示例
另请参阅

定义

MongoDB\Client::selectCollection()

选择服务器上的集合。

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

参数

$databaseName : string

要选择的集合所在的数据库名。

$collectionName : string

要选择的集合名。

$options : array

指定所需选项的数组。

名称	类型	描述
codec	MongoDB\Codec\DocumentCodec	默认codec 用于集合操作。 Newin version1.17.
readConcern	MongoDB\Driver\ReadConcern	用于集合操作的默认读取关注点。默认为客户端的读取关注点。
readPreference	MongoDB\Driver\ReadPreference	用于集合操作的默认读取偏好。默认为客户端的读取偏好。
typeMap	array	用于集合操作的默认类型映射。默认为客户端的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	用于集合操作的默认写入关注点。默认为客户端的写入关注点。

返回值

MongoDB 的 MongoDB\Collection 对象。

错误/异常

MongoDB\Exception\InvalidArgumentException 与参数或选项解析相关的错误。

行为

所选集合继承自 Client 对象的选项，例如读取偏好和类型映射。可以通过 $options 参数覆盖选项。

示例

以下示例选择 users 集合在 test 数据库中

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

以下示例选择 users 集合在 test 数据库中，并使用自定义的读取偏好

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

另请参阅

removeSubscriber()

selectDatabase()