Update the configurations of a search index

Prerequisites

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

• A search index exists for the data table.

• The allowUpdate parameter is set to false for the data table. For more information, see Update the configurations of a table.

Usage notes

• The TTL of a search index is independent of and must be no greater than that of the data table for which the search index is created. If you want to decrease the TTL of a search index and the data table for which the search index is created, you must change the TTL of the search index before you change the TTL of the data table.

• Tablestore automatically deletes expired data from search indexes every day. You can still query expired data in search indexes before the expired data is deleted. Tablestore automatically deletes the expired data in the next cycle.

• After you change the TTL of data tables and search indexes, Tablestore automatically deletes the historical expired data from the data tables and search indexes in the next cycle.

Parameters

Examples

The following example sets the TTL of a search index to seven days (604,800 seconds):

let params = {
    tableName: '<TABLE_NAME>',
    indexName: '<SEARCH_INDEX_NAME>',
    timeToLive: 604800,  // 7 days in seconds (7 x 24 x 60 x 60)
}
client.updateSearchIndex(params, function (err, data) {
    if (err) {
        console.log('updateSearchIndex error:', err.toString());
    } else {
        console.log('updateSearchIndex success:', data);
    }
});

To calculate the timeToLive value for a different duration, multiply the number of days by 86400 (seconds per day). For example, 30 days is 2592000.

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?](t2633375.xdita#)

References

• For information about the TTL of a search index, see Specify the TTL of a search index.

• To query the fields and schema of a search index, see Query the description of a search index.

• To add, update, or remove index columns or change the routing key and presorting method, see Dynamically modify the schema of a search index.