全部產品
Search
文件中心

Tablestore:UpdateSearchIndex

更新時間:Nov 16, 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更新多元索引的生命週期配置。