列出时序表

更新时间:
复制 MD 格式

使用 Java SDK 列出当前实例中的所有时序表,并获取各表的名称、配置和状态。

前提条件

安装Tablestore Java SDK并初始化时序模型客户端。

功能说明

调用 listTimeseriesTable 方法列出当前实例中的所有时序表。

public ListTimeseriesTableResponse listTimeseriesTable()

以下示例列出实例中的时序表,并输出每张表的名称、状态和时序数据生命周期。

TimeseriesClient timeseriesClient = client.asTimeseriesClient();

ListTimeseriesTableResponse response =
        timeseriesClient.listTimeseriesTable();

for (TimeseriesTableMeta tableMeta : response.getTimeseriesTableMetas()) {
    System.out.println(tableMeta.getTimeseriesTableName());
    System.out.println(tableMeta.getStatus());
    System.out.println(tableMeta.getTimeseriesTableOptions().getTimeToLive());
}

参数说明

listTimeseriesTable 方法不接收请求参数。

返回值

ListTimeseriesTableResponse 包含以下业务返回字段。

字段

类型

说明

timeseriesTableMetas

List<TimeseriesTableMeta>

通过 getTimeseriesTableMetas() 获取时序表列表。只需表名时,可通过 getTimeseriesTableNames() 获取名称列表。

时序表信息

timeseriesTableMetas[] 中每个元素的类型为 TimeseriesTableMeta,包含以下字段。

字段

类型

说明

timeseriesTableName

String

通过 getTimeseriesTableName() 获取时序表名称。

timeseriesTableOptions

TimeseriesTableOptions

通过 getTimeseriesTableOptions() 获取时序数据配置。

timeseriesMetaOptions

TimeseriesMetaOptions

通过 getTimeseriesMetaOptions() 获取时间线元数据配置。

status

String

通过 getStatus() 获取时序表状态。

timeseriesKeys

List<String>

通过 getTimeseriesKeys() 获取自定义时间线标识的字段名称列表。未自定义时返回空列表。

fieldPrimaryKeys

List<PrimaryKeySchema>

通过 getFieldPrimaryKeys() 获取作为主键的数据字段列表。未配置时返回空列表。

时序数据配置

timeseriesTableMetas[].timeseriesTableOptions 的类型为 TimeseriesTableOptions,包含以下字段。

字段

类型

说明

timeToLive

int

通过 getTimeToLive() 获取时序数据的生命周期,单位为秒。值为 -1 时,表示数据永不过期。

时间线元数据配置

timeseriesTableMetas[].timeseriesMetaOptions 的类型为 TimeseriesMetaOptions,包含以下字段。

字段

类型

说明

metaTimeToLive

int

通过 getMetaTimeToLive() 获取时间线元数据的生命周期,单位为秒。值为 -1 时,表示时间线元数据永不过期。

allowUpdateAttributes

boolean

通过 getAllowUpdateAttributes() 获取是否允许更新时间线元数据的属性列。

数据字段主键

timeseriesTableMetas[].fieldPrimaryKeys[] 中每个元素的类型为 PrimaryKeySchema,包含以下字段。

字段

类型

说明

name

String

通过 getName() 获取数据字段名称。

type

PrimaryKeyType

通过 getType() 获取数据字段类型,取值为 INTEGERSTRING