MongoDB\数据库::renameCollection()

定义

MongoDB\Database::renameCollection()

重命名当前数据库中的collection。

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

参数

$fromCollectionName ：字符串

要重命名的collection的名称。

$toCollectionName ：字符串

集合的新名称。

$toDatabaseName ：字符串

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

$options : array

指定所需选项的数组。

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

返回值

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

错误/异常

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

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

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

例子

以下示例将restaurants test数据库中的collection重命名为places ：

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

而输出将类似如下所示：

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

另请参阅

• MongoDB\Collection::rename()

• MongoDB 手册中的renameCollection命令参考