Tablestore:Configure the TTL of a search index

Prerequisites

Install the Tablestore SDK for Go and initialize a client.

Considerations

The search index TTL is -1 or an int32 integer no less than 86,400 seconds. -1 indicates that data never expires. For a value other than -1, updates by using UpdateRow must be disabled, and the index TTL cannot exceed the table TTL. Expired data is asynchronously removed in the background.

Procedure

The complete workflow includes disabling UpdateRow updates, configuring the search index TTL, and adjusting the table TTL when needed. The order depends on the target values: If the new index TTL exceeds the current table TTL, increase the table TTL first. Otherwise, adjust the table TTL as needed after configuring the index.

ttl := int32(7 * 24 * 60 * 60)
request := &tablestore.CreateSearchIndexRequest{
    TableName:  "example_table",
    IndexName:  "example_index",
    TimeToLive: &ttl,
    IndexSchema: &tablestore.IndexSchema{
        FieldSchemas: []*tablestore.FieldSchema{
            {
                FieldName: proto.String("category"),
                FieldType: tablestore.FieldType_KEYWORD,
                Index:     proto.Bool(true),
            },
        },
    },
}

_, err := client.CreateSearchIndex(request)
if err != nil {
    log.Fatal(err)
}

ttl := int32(7 * 24 * 60 * 60)
_, err := client.UpdateSearchIndex(&tablestore.UpdateSearchIndexRequest{
    TableName:  "example_table",
    IndexName:  "example_index",
    TimeToLive: &ttl,
})
if err != nil {
    log.Fatal(err)
}

Parameters