MongoDB\Collection::rename()

定义

MongoDB\Collection::rename()

重命名collection。

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

参数

$toCollectionName ： 细绳

集合的新名称。

$toDatabaseName ： 细绳

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

$options : array

指定所需选项的数组。

名称	类型	说明
dropTarget	布尔	如果true，MongoDB 将在重命名collection之前删除目标。默认值为false 。
comment	混合	允许用户指定任意注释，以帮助通过数据库分析器、 currentOp输出和日志跟踪操作。 自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13 版本中的新增功能。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。
typeMap	阵列	类型映射 应用于游标，决定如何将 BSON 文档转换为 PHP 值。默认为集合的类型映射。 这将用于返回的命令结果文档。
writeConcern	MongoDB\Driver\WriteConcern	写关注用于操作。默认为集合的写关注。 无法将单个操作的写关注指定为事务的一部分。 相反，请在writeConcern 启动事务 时设置 选项。

Return Values

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

错误/异常

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

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

MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误（例如连接错误）。

例子

以下操作将test数据库中的restaurantscollection重命名为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)
  }
}

另请参阅

• MongoDB\Database::renameCollection()

• MongoDB 手册中的renameCollection命令参考