MongoDB\Database::renameCollection()
1.10 版本中的新增功能。
定义
参数
$fromCollectionName
: 细绳- 要重命名的collection的名称。
$toCollectionName
: 细绳- 集合的新名称。
$toDatabaseName
: 细绳- collection的新数据库名称。如果未指定新的数据库名称,则使用当前数据库。 如果新名称指定了不同的数据库,则该命令会将collection复制到新数据库并删除源collection。
$options
: array指定所需选项的数组。
错误/异常
MongoDB\Exception\UnsupportedException
,如果所选服务器使用了选项但不支持选项(例如collation
、readConcern
、writeConcern
)。
MongoDB\Exception\InvalidArgumentException
用于与参数或选项解析相关的错误。
MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误(例如连接错误)。
例子
以下示例将restaurants
test
数据库中的collection重命名为places
:
$db = (new MongoDB\Client)->test; $db->renameCollection('restaurants', 'places');
另请参阅
MongoDB 手册中的renameCollection命令参考