查询时序表信息

更新时间:
复制 MD 格式

使用 Java SDK 查询指定时序表的配置和状态,包括生命周期、自定义时间线标识、数据字段主键、分析存储和 Lastpoint 索引。

前提条件

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

功能说明

调用 describeTimeseriesTable 方法查询指定时序表的配置和状态。响应还包含该表的分析存储和 Lastpoint 索引列表;未配置时返回空列表。

public DescribeTimeseriesTableResponse describeTimeseriesTable(DescribeTimeseriesTableRequest request)

以下示例查询 example_timeseries_table 的配置和状态,并读取分析存储及 Lastpoint 索引信息。

TimeseriesClient timeseriesClient = client.asTimeseriesClient();

String tableName = "example_timeseries_table";
DescribeTimeseriesTableRequest request =
        new DescribeTimeseriesTableRequest(tableName);
DescribeTimeseriesTableResponse response =
        timeseriesClient.describeTimeseriesTable(request);

TimeseriesTableMeta tableMeta = response.getTimeseriesTableMeta();
System.out.println(tableMeta.getTimeseriesTableName());
System.out.println(tableMeta.getStatus());
System.out.println(tableMeta.getTimeseriesTableOptions().getTimeToLive());
System.out.println(tableMeta.getTimeseriesMetaOptions().getMetaTimeToLive());
System.out.println(tableMeta.getTimeseriesMetaOptions().getAllowUpdateAttributes());

for (TimeseriesAnalyticalStore store : response.getAnalyticalStores()) {
    System.out.println(store.getAnalyticalStoreName());
    System.out.println(store.getTimeToLive());
    System.out.println(store.getSyncOption());
}

for (TimeseriesLastpointIndex index : response.getLastpointIndexes()) {
    System.out.println(index.getLastpointIndexName());
}

参数说明

DescribeTimeseriesTableRequest 包含以下参数。

名称

类型

说明

timeseriesTableName(必选)

String

时序表名称。

返回值

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

字段

类型

说明

timeseriesTableMeta

TimeseriesTableMeta

通过 getTimeseriesTableMeta() 获取时序表的配置和状态。

analyticalStores

List<TimeseriesAnalyticalStore>

通过 getAnalyticalStores() 获取分析存储列表。未创建分析存储时返回空列表。

lastpointIndexes

List<TimeseriesLastpointIndex>

通过 getLastpointIndexes() 获取 Lastpoint 索引列表。未创建 Lastpoint 索引时返回空列表。

时序表信息

timeseriesTableMeta 的类型为 TimeseriesTableMeta,包含以下字段。

字段

类型

说明

timeseriesTableName

String

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

timeseriesTableOptions

TimeseriesTableOptions

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

timeseriesMetaOptions

TimeseriesMetaOptions

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

status

String

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

timeseriesKeys

List<String>

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

fieldPrimaryKeys

List<PrimaryKeySchema>

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

时序数据配置

timeseriesTableMeta.timeseriesTableOptions 的类型为 TimeseriesTableOptions,包含以下字段。

字段

类型

说明

timeToLive

int

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

时间线元数据配置

timeseriesTableMeta.timeseriesMetaOptions 的类型为 TimeseriesMetaOptions,包含以下字段。

字段

类型

说明

metaTimeToLive

int

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

allowUpdateAttributes

boolean

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

数据字段主键

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

字段

类型

说明

name

String

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

type

PrimaryKeyType

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

分析存储

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

字段

类型

说明

analyticalStoreName

String

通过 getAnalyticalStoreName() 获取分析存储名称。

timeToLive

int

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

syncOption

AnalyticalStoreSyncType

通过 getSyncOption() 获取数据同步方式。

Lastpoint 索引

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

字段

类型

说明

lastpointIndexName

String

通过 getLastpointIndexName() 获取 Lastpoint 索引名称。