文档中心

SequoiaDB 简介

快速入门

安装部署

数据库实例

分布式引擎

SAC管控中心

SequoiaPerf性能分析工具

参考手册

常见问题及解答(FAQ)

版本信息

list()

名称

list - 获取列表

语法

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

类别

Sdb

描述

该函数用于获取指定列表,查看当前系统状态。列表是一种轻量级的命令。

参数

参数名 类型 描述 是否必填
listType macro 需要获取的列表,取值可参考列表类型
cond object 设置匹配条件以及命令位置参数
sel object 选择返回的字段名,为 null 时返回所有的字段名
sort object 对返回的记录按选定的字段排序,取值如下:
1:升序
-1:降序

Note:

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

返回值

函数执行成功时,将返回一个 SdbCursor 类型的对象。

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

错误

当异常抛出时,可以通过 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
      ]
    }
回到顶部