MongoDB\Database::modifyCollection()

定义

MongoDB\Database::modifyCollection()

根据指定的 $collectionOptions 修改集合或视图。

function modifyCollection(
    string $collectionName,
    array $collectionOptions,
    array $options = []
): array|object

参数

$collectionName : 字符串

要修改的集合或视图的名称。

$collectionOptions : 数组

要分配的集合或视图选项。

$options : 数组

指定所需选项的数组。

名称	类型	描述
comment	mixed	允许用户指定一个任意注释来帮助通过数据库分析器、当前操作输出和日志来追踪操作。数据库分析器、当前操作和日志。 此选项自 MongoDB 4.4 起可用，如果指定给较旧的服务器版本，则在执行时将引发异常。 新增在版本1.13.
session	MongoDB\Driver\Session	与操作关联的客户端会话。
typeMap	array	将类型映射应用于游标，它决定了BSON文档如何转换为PHP值。默认为数据库的类型映射。 这将被用于返回的命令结果文档。
写关注	MongoDB\Driver\WriteConcern	写关注用于操作的写关注。默认为数据库的写关注。

返回值

包含collMod命令结果文档的数组或对象。

错误/异常

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

MongoDB\Driver\Exception\RuntimeException 用于其他扩展级别的错误（例如连接错误）。

示例

以下示例修改了 test 数据库中 TTL 集合的过期时间

<?php
$db = (new MongoDB\Client)->test;
$result = $db->modifyCollection('users', [
    'keyPattern' => ['lastAccess' => 1],
    'expireAfterSeconds' => 1000
]);
var_dump($result);

输出结果如下

object(stdClass)#2779 {
  ["expireAfterSeconds_old"]=>
  int(3)
  ["expireAfterSeconds_new"]=>
  int(1000)
  ["ok"]=>
  float(1)
}

另请参阅

• collMod 命令参考，请参阅 MongoDB 手册