Tablestore:Operations on time series tables

Create a time series table in the Tablestore console.

1. Go to the Instance Management page.

   1. Log on to the Tablestore console.

   2. In the top navigation bar, select a resource group and a region.

   3. On the Overview page, click the name of the instance that you want to manage or click Manage Instance in the Actions column of the instance.

2. In the lower part of the Instance Details tab, click the Time Series Tables tab.

3. On the Time Series Tables tab, click Create Time Series Table.

   Note

   You can also click Generate Demo with One Click to create a test table with sample data for a quick start. When you create a time series table, the system performs specific initialization operations. You must wait for several seconds before the time series are displayed.

4. In the Create Time Series Table dialog box, configure the parameters. The following table describes the parameters.

   Parameter	Description
   Name	The name of the time series table, which is used to uniquely identify the time series table in the instance. The name must be 1 to 128 characters in length and can contain only letters, digits, and underscores (_). The name must start with a letter or an underscore (_). Important The name of a time series table must be different from the name of an existing data table, secondary index table, and time series table.
   Time to Live	The retention period of data in the time series table. Unit: seconds. If the system detects that the difference between the current time and the time column that is passed to the table exceeds the specified TTL value, the system automatically deletes the expired data. Important In a time series table, the system determines the time when the data is generated based on the time column that is passed to the table, not based on the time when the data is written to the table. The value of this parameter must be -1 or a value that is greater than or equal to 86400. A value of -1 specifies that the data never expires. A value of 86400 specifies one day.

5. Click OK.

   After you create the time series table, you can view the time series table on the Time Series Tables tab. If the time series table is not displayed in the list of time series tables, click the icon to refresh the list.

After you create the time series table, you can manage the time series table based on your business requirements. The following table describes the operations that you can perform on time series tables.

Run the create command to create a time series table by using the Tablestore CLI. For more information, see Create a time series table.

The following sample code provides an example on how to create a time series table named mytable. Data in the mytable table does not expire.

create -m timeseries -t mytable --ttl -1

Before you perform operations on a table, you must run the use command to select the table that you want to manage. For more information, see Use a time series table.

The following sample code provides an example on how to select the mytable table:

use --ts -t mytable

After you create and select a time series table, you can manage the time series table based on your business requirements. The following table describes the operations that you can perform on time series tables.

list -t

alter --ttl 86400 --ts

desc --ts -t mytable

drop -t mytable --ts -y

You can use Tablestore SDK for Java and Tablestore SDK for Go to create and manage a time series table. In this example, Tablestore SDK for Java is used.

Create a time series table based on your business requirements.

The following sample code provides an example on how to create a time series table named test_timeseries_table whose data never expires.

private static void createTimeseriesTable(TimeseriesClient client) {
    String tableName = "test_timeseries_table";
    TimeseriesTableMeta timeseriesTableMeta = new TimeseriesTableMeta(tableName);
    int timeToLive = -1;
    timeseriesTableMeta.setTimeseriesTableOptions(new TimeseriesTableOptions(timeToLive));
    CreateTimeseriesTableRequest request = new CreateTimeseriesTableRequest(timeseriesTableMeta);
    
    client.createTimeseriesTable(request);
}

After you create the time series table, you can manage the time series table based on your business requirements.

private static void listTimeseriesTable(TimeseriesClient client) {
    ListTimeseriesTableResponse listTimeseriesTableResponse = client.listTimeseriesTable();
    for (String table : listTimeseriesTableResponse.getTimeseriesTableNames()) {
        System.out.println(table);
    }
}

private static void updateTimeseriesTable(TimeseriesClient client) {
    // Specify the name of the time series table. 
    String tableName = "<TIMESERIES_TABLE>";
    UpdateTimeseriesTableRequest updateTimeseriesTableRequest = new UpdateTimeseriesTableRequest(tableName);
    // Change the TTL to three years. 
    updateTimeseriesTableRequest.setTimeseriesTableOptions(new TimeseriesTableOptions(86400 * 365 * 3)); 
    client.updateTimeseriesTable(updateTimeseriesTableRequest);

    DescribeTimeseriesTableResponse describeTimeseriesTableResponse = client.describeTimeseriesTable(new DescribeTimeseriesTableRequest(tableName));
    TimeseriesTableMeta tableMeta = describeTimeseriesTableResponse.getTimeseriesTableMeta();
    // View the modified TTL. 
    System.out.println(tableMeta.getTimeseriesTableOptions().getTimeToLive()); 
}

private static void describeTimeseriesTable(TimeseriesClient client) {
    // Specify the name of the time series table. 
    String tableName = "<TIMESERIES_TABLE>";
    DescribeTimeseriesTableResponse describeTimeseriesTableResponse = client.describeTimeseriesTable(new DescribeTimeseriesTableRequest(tableName));
    TimeseriesTableMeta tableMeta = describeTimeseriesTableResponse.getTimeseriesTableMeta();
    // View the name of the time series table. 
    System.out.println(tableMeta.getTimeseriesTableName()); 
    // View the status of the time series table. 
    System.out.println(tableMeta.getStatus()); 
    // View the TTL of data in the time series table. 
    System.out.println(tableMeta.getTimeseriesTableOptions().getTimeToLive()); 
    // View the TTL of the time series metadata. 
    System.out.println(tableMeta.getTimeseriesMetaOptions().getMetaTimeToLive()); 
    // Check whether the property columns of the time series metadata can be modified. 
    System.out.println(tableMeta.getTimeseriesMetaOptions().getAllowUpdateAttributes()); 
}

private static void deleteTimeseriesTable(TimeseriesClient client) {
    // Specify the name of the time series table. 
    String tableName = "<TIMESERIES_TIME>";
    DeleteTimeseriesTableRequest deleteTimeseriesTableRequest = new DeleteTimeseriesTableRequest(tableName);
    client.deleteTimeseriesTable(deleteTimeseriesTableRequest);
}