全部产品
Search
文档中心

表格存储:UpdateSearchIndex

更新时间:Nov 15, 2024

调用UpdateSearchIndex接口更新多元索引的配置,包括数据生命周期(TTL)和多元索引schema。

注意事项

  • 当修改多元索引生命周期时,请确保数据表为禁止更新状态(即allow_updatefalse)。具体操作,请参见UpdateTable

  • 由于通过SDK调用API修改多元索引schema的操作较复杂,因此如需修改多元索引schema,请通过控制台进行操作。具体操作,请参见动态修改schema

请求消息结构

message UpdateSearchIndexRequest {
    optional string table_name = 1;
    optional string index_name = 2;
    optional string switch_index_name = 3;
    repeated QueryFlowWeight query_flow_weight = 4;
    optional int32 time_to_live = 5;  // unit is seconds
}

名称

类型

是否必选

描述

table_name

string

数据表名称。

index_name

string

多元索引名称。

switch_index_name

string

修改后的多元索引名称。只有当使用动态修改schema功能修改多元索引结构时,才需要设置此参数。

query_flow_weight

QueryFlowWeight

查询权重配置。只有当使用动态修改schema功能修改多元索引结构时,才需要设置此参数。

time_to_live

int32

数据生命周期,即数据保存时间。单位为秒。

默认值为-1,表示数据永不过期。数据生命周期的取值最低为86400秒(一天),也可设置为-1(永不过期)。

当数据的保存时间超过设置的数据生命周期时,系统会自动清理超过数据生命周期的数据。

多元索引的TTL和数据表的TTL是独立的,多元索引的TTL值必须小于或等于数据表的TTL值。当需要同时调小多元索引TTL和数据表TTL时,请先调整多元索引TTL,再调整数据表TTL。

响应消息结构

message UpdateSearchIndexResponse {
}

您需要通过判断HTTP请求的status取值是否为200来确定是否执行成功。

  • 如果status取值为200,则表示执行成功。

  • 如果status取值为400或者500,则表示执行失败。

    如果请求执行失败时,则会返回Error信息。更多信息,请参见Error

使用SDK

您可以使用如下语言的SDK更新多元索引的生命周期配置。