表格存储 Java SDK 更新多元索引生命周期 - 表格存储

前提条件

开始前，完成以下准备工作：

安装 5.12.0 及以上版本的 Tablestore Java SDK 并初始化客户端。
已创建待更新的数据表和多元索引，并禁止数据表通过 UpdateRow 更新数据。关于数据表更新设置，请参见更新表配置。

功能说明

调用 updateSearchIndex 方法更新指定多元索引的数据生命周期。

public UpdateSearchIndexResponse updateSearchIndex(UpdateSearchIndexRequest request)

如需增删索引字段、修改字段类型、路由字段或预排序配置，请参见动态修改 Schema。

重要

配置生命周期时，注意以下事项：

数据表和多元索引的生命周期相互独立，索引生命周期不能超过数据表生命周期。如果需要同时缩短二者的生命周期，请先更新多元索引，再更新数据表。
多元索引按天清理过期数据。数据过期后、下次清理前，查询仍可能返回这些数据。
缩短生命周期后，系统在后续清理任务中删除已过期的存量数据。

以下示例将 example_table 中 example_index 的生命周期更新为 7 天。

String tableName = "example_table";
String indexName = "example_index";
UpdateSearchIndexRequest request =
        new UpdateSearchIndexRequest(tableName, indexName);
request.setTimeToLiveInDays(7);

client.updateSearchIndex(request);

请求成功后，查询多元索引信息，确认 timeToLive 已变为 604800 秒。

参数说明

UpdateSearchIndexRequest 更新索引生命周期时使用以下参数：

名称	类型	说明
tableName（必选）	`String`	数据表名称。
indexName（必选）	`String`	多元索引名称。
timeToLive（必选）	`Integer`	索引数据的生命周期，单位为秒。取值为 `-1` 或 int32 范围内的正整数，`-1` 表示数据永不过期，最大值约为 68 年。通过 `setTimeToLive(int, TimeUnit)` 指定时间单位，或通过 `setTimeToLiveInDays(int)` 按天设置。