dropCL()

名称

dropCL - 删除当前集合空间下指定的集合

语法

db.collectionspace.dropCL(<name>, [options])

类别

SdbCS

描述

该函数用于删除当前集合空间下指定的集合。

参数

• name（ string，必填 ）

  集合名

• options（ object，选填 ）

  通过 options 可以设置其他选填参数：

  • SkipRecycleBin（ boolean ）：是否禁用回收站机制，默认是 false，表示根据字段 Enable 的值决定是否启用回收站机制

    该参数取值为 true，表示删除集合时将不生成对应的回收站项目。

    格式：SkipRecycleBin: true

返回值

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

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

错误

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

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

版本

v1.0 及以上版本

示例

删除集合空间 sample 下的集合 employee

> db.sample.dropCL("employee")