snapshot()

名称

snapshot - 查看回收站项目快照

语法

db.getRecycleBin().snapshot([cond], [sel], [sort]) db.getRecycleBin().snapshot([SdbSnapshotOption])

类别

SdbRecycleBin

描述

该函数用于查看回收站项目快照。

参数

• cond（ object，选填 ）

  匹配条件以及命令位置参数，只返回符合 cond 的记录

• sel（ object，选填 ）

  选择返回的字段名

• sort（ object，选填 ）

  对返回的记录按选定的字段排序，取值如下：

  • 1：升序
  • -1：降序

• SdbSnapshotOption（ SdbSnapshotOption，选填 ）

  使用一个对象指定快照查询参数，使用方法可参考 SdbSnapshotOption

返回值

函数执行成功时，将返回一个 SdbCursor 类型的对象。通过该对象获取回收站项目快照，字段说明可参考回收站项目快照。

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

错误

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

版本

v5.0.3 及以上版本

示例

查看所有回收站项目的快照

> db.getRecycleBin().snapshot()