MongoDB\Database::renameCollection()

定义

MongoDB\Database::renameCollection()

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

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

参数

$fromCollectionName ： 细绳

要重命名的collection的名称。

$toCollectionName ： 细绳

集合的新名称。

$toDatabaseName ： 细绳

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

$options : array

指定所需选项的数组。

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

错误/异常

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

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

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

例子

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

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

另请参阅

• MongoDB\Collection::rename()

• MongoDB 手册中的renameCollection命令参考