MongoDB\Collection::withOptions()

定义

MongoDB\Collection::withOptions()

返回 Collection 对象的克隆，但具有不同的选项。

function withOptions(array $options = []): MongoDB\Collection

参数

$options : 数组

指定所需选项的数组。

名称	类型	描述
codec	MongoDB\Codec\DocumentCodec	默认codec 用于集合操作。默认为原始集合的 codec。 新增加在版本1.17.
readConcern	MongoDB\Driver\ReadConcern	用于集合操作的默认读取关注点。默认为原始集合的读取关注点。
readPreference	MongoDB\Driver\ReadPreference	用于集合操作的默认读取偏好。默认为原始集合的读取偏好。
typeMap	数组	应用于游标的 类型映射，它决定了 BSON 文档如何转换为 PHP 值。默认为原始集合的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	用于集合操作的默认写入关注点。默认为原始集合的写入关注点。

返回值

一个 MongoDB\Collection 对象。

错误/异常

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

示例

以下示例使用新的读取偏好克隆现有的 Collection 对象

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

另请参阅

• MongoDB\Collection::__construct()