MongoDB\Database::selectCollection()

本页内容

定义

参数
返回值
错误/异常
行为
示例
相关内容

定义

MongoDB\Database::selectCollection()

在数据库中选取一个集合。

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

参数

$collectionName : string

要选择的集合名称。

$options : array

指定所需选项的数组。

名称	类型	描述
codec	MongoDB\Codec\DocumentCodec	默认codec 用于集合操作。新增于版本1.17.
readConcern	MongoDB\Driver\ReadConcern	用于集合操作的默认读取关注点。默认为数据库的读取关注点。
readPreference	MongoDB\Driver\ReadPreference	用于集合操作的默认读取偏好。默认为数据库的读取偏好。
typeMap	array	用于集合操作的默认类型映射。默认为数据库的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	用于集合操作的默认写入关注点。默认为数据库的写入关注点。

返回值

MongoDB Collection 对象。

错误/异常

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

行为

所选集合继承了数据库对象的可选参数，如读取偏好和类型映射。可以通过 $options 参数来覆盖这些选项。

示例

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

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

以下示例在具有自定义读取偏好的情况下选择了在 test 数据库中的 users 集合

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

另请参阅

renameCollection()

selectGridFSBucket()