Query time series table information - Tablestore SDK for Java - Tablestore

Use Tablestore SDK for Java to query the configurations and status of a time series table, including its TTL, custom time series identifier fields, data field primary keys, analytical stores, and Lastpoint indexes.

Prerequisites

Install the Tablestore SDK for Java and initialize a time series client.

Description

Call describeTimeseriesTable to query the configurations and status of a time series table. The response also contains lists of analytical stores and Lastpoint indexes. An empty list is returned if no corresponding resource is configured.

public DescribeTimeseriesTableResponse describeTimeseriesTable(DescribeTimeseriesTableRequest request)

The following example queries the configurations and status of example_timeseries_table and reads analytical store and Lastpoint index information.

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());
}

Parameters

DescribeTimeseriesTableRequest contains the following parameter.

Name	Type	Description
timeseriesTableName (required)	`String`	The time series table name.

Response

DescribeTimeseriesTableResponse contains the following operation-specific fields.

Field	Type	Description
`timeseriesTableMeta`	`TimeseriesTableMeta`	Call `getTimeseriesTableMeta()` to obtain the configurations and status of the time series table.
`analyticalStores`	`List<TimeseriesAnalyticalStore>`	Call `getAnalyticalStores()` to obtain the analytical stores. An empty list is returned if no analytical store is created.
`lastpointIndexes`	`List<TimeseriesLastpointIndex>`	Call `getLastpointIndexes()` to obtain the Lastpoint indexes. An empty list is returned if no Lastpoint index is created.

Time series table information

timeseriesTableMeta is of the TimeseriesTableMeta type and contains the following fields.

Field	Type	Description
`timeseriesTableName`	`String`	Call `getTimeseriesTableName()` to obtain the time series table name.
`timeseriesTableOptions`	`TimeseriesTableOptions`	Call `getTimeseriesTableOptions()` to obtain the time series data configurations.
`timeseriesMetaOptions`	`TimeseriesMetaOptions`	Call `getTimeseriesMetaOptions()` to obtain the time series metadata configurations.
`status`	`String`	Call `getStatus()` to obtain the time series table status.
`timeseriesKeys`	`List<String>`	Call `getTimeseriesKeys()` to obtain the custom time series identifier fields. An empty list is returned if no custom fields are configured.
`fieldPrimaryKeys`	`List<PrimaryKeySchema>`	Call `getFieldPrimaryKeys()` to obtain the data fields used as primary keys. An empty list is returned if no data field primary key is configured.

Time series data configurations

timeseriesTableMeta.timeseriesTableOptions is of the TimeseriesTableOptions type and contains the following field.

Field	Type	Description
`timeToLive`	`int`	Call `getTimeToLive()` to obtain the time series data TTL in seconds. A value of `-1` indicates that the data does not expire.

Time series metadata configurations

timeseriesTableMeta.timeseriesMetaOptions is of the TimeseriesMetaOptions type and contains the following fields.

Field	Type	Description
`metaTimeToLive`	`int`	Call `getMetaTimeToLive()` to obtain the time series metadata TTL in seconds. A value of `-1` indicates that the metadata does not expire.
`allowUpdateAttributes`	`boolean`	Call `getAllowUpdateAttributes()` to determine whether metadata attribute columns can be updated.

Data field primary keys

Each element in timeseriesTableMeta.fieldPrimaryKeys[] is of the PrimaryKeySchema type and contains the following fields.

Field	Type	Description
`name`	`String`	Call `getName()` to obtain the data field name.
`type`	`PrimaryKeyType`	Call `getType()` to obtain the data field type. Valid values: `INTEGER` and `STRING`.

Analytical stores

Each element in analyticalStores[] is of the TimeseriesAnalyticalStore type and contains the following fields.

Field	Type	Description
`analyticalStoreName`	`String`	Call `getAnalyticalStoreName()` to obtain the analytical store name.
`timeToLive`	`int`	Call `getTimeToLive()` to obtain the TTL of data in the analytical store, in seconds. A value of `-1` indicates that the data does not expire.
`syncOption`	`AnalyticalStoreSyncType`	Call `getSyncOption()` to obtain the data synchronization method.

Lastpoint indexes

Each element in lastpointIndexes[] is of the TimeseriesLastpointIndex type and contains the following field.

Field	Type	Description
`lastpointIndexName`	`String`	Call `getLastpointIndexName()` to obtain the Lastpoint index name.