List time series tables - Tablestore SDK for Java - Tablestore

Use Tablestore SDK for Java to list all time series tables in an instance and retrieve their names, configurations, and status information.

Prerequisites

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

Description

Call listTimeseriesTable to list all time series tables in the current instance.

public ListTimeseriesTableResponse listTimeseriesTable()

The following example lists time series tables and prints the name, status, and time series data TTL of each table.

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

Parameters

The listTimeseriesTable method does not take request parameters.

Response

ListTimeseriesTableResponse contains the following operation-specific field.

Field	Type	Description
`timeseriesTableMetas`	`List<TimeseriesTableMeta>`	Call `getTimeseriesTableMetas()` to obtain the time series table list. To obtain only the table names, call `getTimeseriesTableNames()`.

Time series table information

Each element in timeseriesTableMetas[] 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

timeseriesTableMetas[].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

timeseriesTableMetas[].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 timeseriesTableMetas[].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 are `INTEGER` and `STRING`.