- renameCL()
- 语法
- 参数描述
- 返回值
- 错误
- 版本信息
- 示例
renameCL()
语法
db.collectionspace.renameCL( <oldname>, <newname> )
集合改名。
参数描述
参数名 | 参数类型 | 描述 | 是否必填 |
---|---|---|---|
oldname | 字符串 | 要修改的集合名。 | 是 |
newname | 字符串 | 集合新名字。 | 是 |
Note:
- 改名过程中会阻塞相应数据节点的写操作。
- 不允许直连数据节点,对集合改名。
返回值
无返回值,出错抛异常,并输出错误信息。
错误
常见异常如下:
错误码 | 错误类型 | 描述 | 解决方法 |
---|---|---|---|
-23 | SDB_DMS_NOTEXIST | oldname对应的集合不存在。 | 对已存在的集合执行rename。 |
-22 | SDB_DMS_EXIST | newname对应的集合已存在。 | newname设为不存在的名字。 |
-67 | SDB_BACKUP_HAS_ALREADY_START | 数据节点正在做备份。 | 等待备份完成,再执行改名。 |
-148 | SDB_DMS_STATE_NOT_COMPATIBLE | 数据节点上有其他rename操作正在执行。 | 等待其余rename完成,再执行改名。 |
-149 | SDB_REBUILD_HAS_ALREADY_START | 数据节点正在做rebuild。 | 等待rebuild完成,再执行改名。 |
当异常抛出时,可以通过 getLastErrObj() 或 getLastErrMsg() 获取错误信息 或 通过 getLastError() 获取错误码。更多错误可以参考常见错误处理指南 。
版本信息
3.0.1及以上版本
示例
对集合foo.bar,改名为foo.bar_new 。
- // 连接协调节点
- > db = new Sdb( "localhost", 11810 )
- > db.foo.renameCL( "bar", "bar_new" )