Docs 菜单
Docs 主页
/
MongoDB Manual
/
参考
/
数据库命令
/
管理

renameCollection

在此页面上

  • 定义
  • 兼容性
  • 语法
  • 命令字段
  • 行为
  • 例子

定义

renameCollection

更改现有集合的名称。以完整 命名空间 ( <database>.<collection>) 的形式将集合名称指定为 renameCollection。

提示

在 mongosh 中，该命令也可通过 renameCollection() 辅助方法运行。

辅助方法对 mongosh 用户来说很方便，但它们返回的信息级别可能与数据库命令不同。如果不追求方便或需要额外的返回字段，请使用数据库命令。

对管理员数据库发出 renameCollection 命令。

兼容性

此命令可用于以下环境中托管的部署：

  • MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

注意

所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息，请参阅不支持的命令。

语法

该命令具有以下语法：

db.runCommand(
   {
     renameCollection: "<source_namespace>",
     to: "<target_namespace>",
     dropTarget: <true|false>,
     writeConcern: <document>,
     comment: <any>
   }
)

命令字段

该命令包含以下字段：

字段
类型
说明

renameCollection

字符串

要重命名的集合的命名空间。命名空间是数据库名称和集合名称的组合。

to

字符串

集合的新命名空间。如果新命名空间指定了不同的数据库，则renameCollection 命令会将集合复制到新数据库并删除源集合。请参阅命名限制。

dropTarget

布尔

可选。如果为true ，mongod 将在重命名集合之前删除target 的renameCollection 。默认值为false 。

writeConcern

文档

可选。表达该操作的写关注的文档。省略以使用默认的写关注。

在分分片集群上发出时， 会将mongos 命令及其帮助程序 renameCollection的写关注（writedb.collection.renameCollection() concern）转换为"majority" 。

comment

any

可选。用户提供的待附加到该命令的注释。设置后，该注释将与该命令的记录一起出现在以下位置：

注释可以是任何有效的 BSON 类型（字符串、整型、对象、数组等）。

行为

分片集合

从 MongoDB 5.0 开始，您可以使用 renameCollection 命令来更改分片集合的名称。目标数据库必须与源数据库相同。

未分片集合

只要源数据库和目标数据库在同一主分片上，就可以使用 renameCollection 对分片集群中的未分片集合进行重命名。

时间序列集合

不能使用 renameCollection 重命名时间序列集合。有关详细信息，请参阅时间序列集合限制。

现有目标集合

如果 target 是现有集合的名称且您未指定 dropTarget: true，则 renameCollection 将失败。

性能

3.6 版本中的更改。

renameCollection 对性能会产生不同的影响，具体取决于目标命名空间。

如果目标数据库与源数据库相同，renameCollection 只需更改命名空间即可。这是一项快速操作。

如果目标数据库与源数据库不同，renameCollection 会将所有文档从源集合复制到目标集合中。这可能需要更长的时间才能完成，具体取决于集合的大小。

分片集群中的资源锁定

5.0 版本中的更改。

重命名分片集群中的分片集合或非分片集合时，源集合和目标集合都以独占方式锁定在每个分片上。对源集合和目标集合的后续操作必须等待重命名操作完成。

有关 MongoDB 中锁定的更多信息，请参阅常见问题解答：并发。

副本集中的资源锁定

如果对同一数据库中的集合进行重命名，renameCollection 会在该操作期间获得对源集合和目标集合的独占锁。对集合的所有后续操作都必须一直等到 renameCollection 完成。

如果在不同数据库之间重命名集合，renameCollection 会获取目标数据库上的独占 (W) 锁，源数据库上的意图共享 (r) 锁，以及源集合上的共享 (S) 锁。对目标数据库的后续操作必须等到 renameCollection 释放独占数据库锁。

有关 MongoDB 中锁定的更多信息，请参阅常见问题解答：并发。

local Database

  • 您无法将已复制数据库中的集合重命名为未复制的 local 数据库中的集合名称。

  • 您无法将未复制的 local 数据库中的集合重命名为已复制数据库中的集合名称。

打开游标

警告

使用 db.collection.renameCollection() 方法和 renameCollection 命令可以使打开的游标失效，从而中断当前正在返回数据的查询。

Change Streams

对于变更流，db.collection.renameCollection() 方法和 renameCollection 命令会为源集合或目标集合上打开的任何现有变更流创建 invalidate 状态。

互动 mongodump

如果客户端在转储过程中发出 renameCollection 命令，以 --oplog 开头的 mongodump 将失败。有关更多信息，请参阅 mongodump.--oplog。

例子

以下示例会将 test 数据库中名为 orders 的集合重命名为 test 数据库中的orders2014。

db.adminCommand( { renameCollection: "test.orders", to: "test.orders2014" } )

mongosh 为命令提供了 db.collection.renameCollection() 辅助方法，可对同一数据库中的集合进行重命名。以下内容与之前的示例等效：

use test
db.orders.renameCollection( "orders2014" )

后退

reIndex

来年

rotateCertificates