文档

关于 SequoiaDB

快速入门

快速入门之一键清理

安装

基本操作

数据模型

SQL引擎

FileSystem引擎

S3引擎

系统架构

数据库管理

连接器

驱动

参考手册

SequoiaDB Shell方法

概述

Global

Sdb

SecureSdb

SdbCS

SdbCollection

SdbCursor

SdbQuery

SdbReplicaGroup

SdbNode

SdbDomain

Oma

File

FileContent

Cmd

Remote

Hash

IniFile

Sdbtool

Ssh

System

辅助类型对象

特殊类型对象

操作符

SQL语法

SQL to SequoiaDB 映射表

限制

错误码

故障排除

SAC 管控中心

Web服务

版本信息

list()

语法

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

枚举列表,列表是一种轻量级得到当前系统状态的命令。查看更多有关列表信息

参数描述

参数名 参数类型 描述 是否必填
listType 枚举 列表类型
cond Json 对象 设置匹配条件以及命令位置参数
sel Json 对象 选择返回的字段名。为 null 时,返回所有的字段名。
sort Json 对象 对返回的记录按选定的字段排序。1为升序;-1为降序。

Note:

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

返回值

返回游标对象,出错抛异常,并输出错误信息,可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。 关于错误处理可以参考常见错误处理指南

错误

常见错误可参考错误码

示例

  • 指定 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": "foo",
      "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": "foo",
      "ID": 4094
    }
  • 指定命令位置参数,只返回数据组 db1 的 context:

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