Java SDK生命周期管理 - 表格存储

数据生命周期（Time To Live，简称TTL）是多元索引的一个属性，即数据的保存时间。多元索引会自动清理超过保存时间的数据，减少用户的数据存储空间，降低存储成本。

前提条件

已初始化OTSClient。具体操作，请参见初始化OTSClient。
已创建数据表。具体操作，请参见创建数据表。

注意事项

使用生命周期管理功能，必须禁用数据表的UpdateRow更新写入功能，避免一些语义上的问题：
由于数据表TTL是属性列级别生效的，而多元索引TTL是整行生效的，如果存在UpdateRow写入操作，当系统清理数据表中数据时，数据表中部分字段值已删除而部分字段值未删除，但是多元索引中整行数据均未删除，则会造成数据表和多元索引中的数据不一致。
如果业务有UpdateRow更新写入操作，请查看是否能改为PutRow覆盖写入操作。
多元索引的TTL取值范围为-1或者int32的正整数（单位为秒），其中-1表示永久存储，int32最大值换算为年大约为68年。
多元索引的TTL和数据表的TTL是独立的，多元索引的TTL值必须小于或等于数据表的TTL值。当需要同时调小多元索引TTL和数据表TTL时，请先调整多元索引TTL，再调整数据表TTL。
多元索引每天会自动清理已过期的数据，过期数据的清理粒度为“天”，因此您仍然可以查询到某一时刻已过期但是还未及时清理的数据，多元索引会在下一次清理过期数据时自动清理这些过期数据。
数据表和多元索引的TTL更新后，系统会在下一次清理过期数据时自动清理数据表和多元索引中的存量过期数据。

使用流程

禁用数据表UpdateRow更新写入操作。

以下示例用于禁用数据表的UpdateRow更新写入操作。

public static void disableTableUpdate(SyncClient client) {
    UpdateTableRequest updateTableRequest = new UpdateTableRequest("<TABLE_NAME>");
    TableOptions options = new TableOptions();
    // 禁用数据表UpdateRow更新写入操作，请确保数据表无UpdateRow写入操作，避免影响业务。
    options.setAllowUpdate(false);
    updateTableRequest.setTableOptionsForUpdate(options);
    client.updateTable(updateTableRequest);
}

设置多元索引生命周期。

禁用数据表UpdateRow更新写入操作后，您可以在创建多元索引时指定TTL或者为已有多元索引指定TTL。

创建多元索引时指定TTL

以下示例用于创建一个多元索引，多元索引包含Col_Keyword和Col_Long两列，类型分别设置为字符串（String）和整型（Long）。同时指定多元索引生命周期为7天。

// 请使用5.12.0及以上版本的Java SDK。
public static void createIndexWithTTL(SyncClient client) {
    int days = 7;
    CreateSearchIndexRequest createRequest = new CreateSearchIndexRequest();
    //设置数据表名称。
    createRequest.setTableName("<TABLE_NAME>");
    //设置多元索引名称。
    createRequest.setIndexName("<SEARCH_INDEX_NAME>");
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            //设置字段名和类型。
            new FieldSchema("Col_Keyword", FieldType.KEYWORD), 
            new FieldSchema("Col_Long", FieldType.LONG)));
    createRequest.setIndexSchema(indexSchema);
    //设置多元索引TTL。
    createRequest.setTimeToLiveInDays(days);
    //调用client创建多元索引。
    client.createSearchIndex(createRequest);
}

为已有多元索引指定TTL

以下示例用于指定已有多元索引的生命周期为7天。

// 请使用5.12.0及以上版本的Java SDK。
public static void updateIndexWithTTL(SyncClient client) {
    int days = 7;
    UpdateSearchIndexRequest updateSearchIndexRequest = new UpdateSearchIndexRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>");
    // 更新多元索引TTL。
    updateSearchIndexRequest.setTimeToLiveInDays(days);
    client.updateSearchIndex(updateSearchIndexRequest);
}

多元索引的TTL和数据表的TTL是独立的。如果需要使用数据表TTL，请为数据表设置TTL。

以下示例用于指定数据表的生命周期为7天。

public static void updateTableTTL(SyncClient client) {
    int days = 7;
    UpdateTableRequest updateTableRequest = new UpdateTableRequest("<TABLE_NAME>");
    TableOptions options = new TableOptions();
    options.setTimeToLiveInDays(days);
    updateTableRequest.setTableOptionsForUpdate(options);
    client.updateTable(updateTableRequest);
}

常见问题

修改数据表生命周期时报错[table ttl] must be bigger than or equal search index ttl

表格存储：生命周期管理