MongoDB\Database::renameCollection()

定义

MongoDB\Database::renameCollection()

在当前数据库中重命名集合。

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

参数

$fromCollectionName : string

要重命名的集合的名称。

$toCollectionName : string

集合的新名称。

$toDatabaseName : string

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

$options : array

指定所需选项的数组。

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

返回值

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

错误/异常

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

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

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

示例

以下示例将 test 数据库中的 restaurants 集合重命名为 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()

• renameCollection 命令参考 MongoDB 手册