list()

名称

list - 枚举列表

语法

db.list( <listType>, [cond], [sel], [sort] )

类别

Sdb

描述

该函数用于枚举列表。列表是一种轻量级的得到当前系统状态的命令。

参数

Note:

• listType 字段的值请参考列表类型。
• sel 参数是一个json结构，如：{字段名:字段值}，字段值一般指定为空串。sel中指定的字段名在记录中存在，设置字段值不生效；不存在则返回sel中指定的字段名和字段值。
• 记录中字段值类型为数组，用户可以在sel中指定该字段名，用"."操作符加上双引号("")来引用数组元素。

返回值

函数执行成功时，将返回游标对象。

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

错误

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

版本

v2.0 及以上版本

示例

• 指定 listType 的值为 SDB_LIST_CONTEXTS：

  > db.list( SDB_LIST_CONTEXTS )
  {
    "NodeName": "ubuntu-200-043:11850",
    "SessionID": 29,
    "TotalCount": 1,
    "Contexts": [
      254
    ]
  }

• 指定 listType 的值为 SDB_LIST_STORAGEUNITS：

  > db.list( SDB_LIST_STORAGEUNITS )
  {
    "NodeName": "ubuntu-200-043:11830",
    "Name": "sample",
    "UniqueID": 61,
    "ID": 4094,
    "LogicalID": 186,
    "PageSize": 65536,
    "LobPageSize": 262144,
    "Sequence": 1,
    "NumCollections": 1,
    "CollectionHWM": 1,
    "Size": 306315264
  }

• 返回符合条件 LogicalID 大于1的记录，并且每条记录只返回 Name 和 ID 这两个字段，记录按 Name 字段的值升序排序

  > db.list( SDB_LIST_STORAGEUNITS, { "LogicalID": { $gt: 1 } }, { Name: "", ID: "" }, { Name: 1 } )
  {
    "Name": "sample",
    "ID": 4094
  }

• 指定命令位置参数，只返回数据组 db1 的 context：

  > db.list( SDB_LIST_CONTEXTS, { GroupName: "db1" } )
  {
    "NodeName": "ubuntu-200-043:20000",
    "SessionID": 29,
    "TotalCount": 1,
    "Contexts": [
      254
    ]
  }