dropCS()

名称

dropCS - 删除一个已存在的集合空间。

语法

db.dropCS(<name>, [options])

类别

Sdb

描述

删除一个已存在的集合空间。

参数

• name ( String， 必填 )

  集合空间名。

• options ( Object， 选填 )

  在删除集合空间时，可以通过options参数设置选项。options 选项如下：

  1. EnsureEmpty ( Bool )：删除集合空间时，是否检查集合空间为空。默认为 false 。其可选取值如下：

     • true：当集合空间下存在集合时，不执行删除操作，返回失败，错误码为 -275 ；当集合空间下不存在集合时，执行删除并返回结果
     • false：不做检查，直接删除集合空间及其包含的相关集合

     格式：EnsureEmpty:true|false

  2. SkipRecycleBin ( Bool )：删除集合空间时，是否禁用回收站机制，默认是 false。其可选取值如下：

     • true：删除集合空间时，将不生成对应的回收站项目
     • false：根据字段 Enable 的值决定是否启用回收站机制

     格式：SkipRecycleBin:true|false

返回值

成功：指定的集合空间被删除。

失败：抛出异常。

错误

dropCS()函数常见异常如下：

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

版本

v1.0及以上版本。

例子

1. 删除名为 sample 的集合空间，假定 sample 已存在

   > db.dropCS("sample")