MongoDB\Collection::rename()

本页内容

新在版本1.10.

定义

MongoDB\Collection::rename()

重命名集合。

function rename(
    string $toCollectionName,
    ?string $toDatabaseName = null,
    array $options = []
): array|object

$toCollectionName : string

集合的新名称。

$toDatabaseName : string

集合的新数据库名称。如果没有指定新数据库名称，则使用原始集合的数据库。如果新名称指定了不同的数据库，则命令会将集合复制到新数据库并删除源集合。

$options : array

一个数组，指定所需的选项。

名称	类型	描述
dropTarget	布尔值	如果 `true`，MongoDB 在重命名集合之前将删除目标。默认值为 `false`。
comment	混合	允许用户指定一个任意的注释，以帮助通过操作追踪操作。数据库分析器，当前操作输出，以及日志。此选项自MongoDB 4.4版起可用，如果指定用于较旧的服务器版本，则在执行时将引发异常。新在版本1.13.
会话	MongoDB\Driver\Session	与操作关联的客户端会话。
typeMap	数组	应用于游标的类型映射，用于确定如何将BSON文档转换为PHP值。默认为集合的类型映射。这将被用于返回的命令结果文档。
writeConcern	MongoDB\Driver\WriteConcern	写入关注用于操作。默认为集合的写入关注。无法在事务中指定单个操作的写入关注。相反，在开始事务时设置`writeConcern`选项。

一个包含 renameCollection 命令的结果文档的数组或对象。返回类型将取决于 typeMap 选项。

如果使用选项且所选服务器不支持这些选项（例如 collation、readConcern、writeConcern）时，将抛出 MongoDB\Exception\UnsupportedException。

对于与参数或选项解析相关的错误，将抛出 MongoDB\Exception\InvalidArgumentException。

对于扩展级别的其他错误（例如连接错误），将抛出 MongoDB\Driver\Exception\RuntimeException。

以下操作将 test 数据库中的 restaurants 集合重命名为 places

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$result = $collection->rename('places');
var_dump($result);

输出将类似于

object(MongoDB\Model\BSONDocument)#9 (1) {
  ["storage":"ArrayObject":private]=>
  array(1) {
    ["ok"]=>
    float(1)
  }
}

mapReduce()

replaceOne()