renameCL()

名称

renameCL - 修改集合名

语法

db.collectionspace.renameCL( <oldname>, <newname> )

类别

Collection Space

描述

该函数用于对指定集合空间下已存在的集合进行重命名，在重命名的过程中会阻塞相应数据节点的写操作。

用户在使用该函数时，不允许直接连接数据节点对集合进行改名。

参数

  • oldname（ String，必填 ）

    需要修改的集合名

  • newname（ String，必填 ）

    修改后的集合名

返回值

函数执行成功时无返回值。

函数执行失败时，将抛出异常并输出错误信息。

错误

常见异常如下：

错误码错误类型描述解决方法
-23SDB_DMS_NOTEXISToldname对应的集合不存在。对已存在的集合执行rename。
-22SDB_DMS_EXISTnewname对应的集合已存在。newname设为不存在的名字。
-67SDB_BACKUP_HAS_ALREADY_START数据节点正在做备份。等待备份完成，再执行改名。
-148SDB_DMS_STATE_NOT_COMPATIBLE数据节点上有其他rename操作正在执行。等待其余rename完成，再执行改名。
-149SDB_REBUILD_HAS_ALREADY_START数据节点正在做rebuild。等待rebuild完成，再执行改名。

当异常抛出时，可以通过 getLastErrObj() 或 getLastErrMsg() 获取错误信息 或 通过 getLastError() 获取错误码。 更多错误可以参考常见错误处理指南 。

版本信息

3.0.1及以上版本

示例

将集合 sample.employee，改名为 sample.employee_new

  1.  > db = new Sdb( "localhost", 11810 )    // 连接协调节点
  2.  > db.sample.renameCL( "employee", "employee_new" )