Tablestore:Update search index configurations

Prerequisites

Make sure that you have completed the following preparations:

• An initialized OTSClient instance. For more information, see Initialize an OTSClient instance

• A search index created for a data table

• The allow_update parameter of the data table is set to False. For more information, see Update the configurations of a table

Usage notes

• The search index TTL is independent of the data table TTL but must not exceed it.

• To decrease the TTL, change the search index TTL first, then the data table TTL.

• Tablestore automatically deletes expired data from search indexes once per day. Expired data remains queryable until the next deletion cycle.

• After you update the TTL, Tablestore deletes historical expired data in the next daily deletion cycle.

Parameters

Examples

The following example sets the search index TTL to seven days:

import os
from tablestore import OTSClient
from tablestore.metadata import SearchIndexMeta

# Initialize the client with environment variable credentials
client = OTSClient(
    end_point=os.environ["OTS_ENDPOINT"],
    access_key_id=os.environ["OTS_ACCESS_KEY_ID"],
    access_key_secret=os.environ["OTS_ACCESS_KEY_SECRET"],
    instance_name=os.environ["OTS_INSTANCE"],
)

TABLE_NAME = "<TABLE_NAME>"
INDEX_NAME = "<SEARCH_INDEX_NAME>"

def update_search_index_ttl(client, table_name, index_name, ttl_seconds):
    """Update the TTL of a search index.

    Args:
        client: An initialized OTSClient instance.
        table_name: The name of the data table.
        index_name: The name of the search index.
        ttl_seconds: TTL in seconds. Use -1 for no expiration.
    """
    # Set fields to None because only the TTL is being updated
    index_meta = SearchIndexMeta(fields=None, time_to_live=ttl_seconds)
    client.update_search_index(table_name, index_name, index_meta)
    print(f"Search index TTL updated to {ttl_seconds} seconds.")

# Set TTL to 7 days (in seconds)
seven_days = 24 * 3600 * 7
update_search_index_ttl(client, TABLE_NAME, INDEX_NAME, seven_days)

def verify_search_index_ttl(client, table_name, index_name):
    """Print the current TTL of a search index."""
    index_meta, sync_stat = client.describe_search_index(table_name, index_name)
    print(f"Current TTL: {index_meta.time_to_live} seconds")

verify_search_index_ttl(client, TABLE_NAME, INDEX_NAME)

# Disable TTL (data never expires)
index_meta = SearchIndexMeta(fields=None, time_to_live=-1)
client.update_search_index(TABLE_NAME, INDEX_NAME, index_meta)

FAQ

What do I do if the [table ttl] must be bigger than or equal search index ttl error message is returned when I modify the TTL of a data table?

References

• Specify the TTL of a search index: Understand search index TTL concepts and behavior.

• Query the description of a search index: Retrieve detailed information about a search index, including fields and schema.

• Dynamically modify the schema of a search index: Add, update, or remove index columns, and change routing keys or presorting methods.