All Products
Search
Document Center

Tablestore:Query the description of a search index

Last Updated:Apr 28, 2024

After you create a search index for a data table, you can call the DescribeSearchIndex operation to query the description of the search index, including the fields and configurations of the search index.

Prerequisites

Parameters

Parameter

Description

table_name

The name of the data table.

index_name

The name of the search index.

Examples

index_meta, sync_stat = client.describe_search_index(table_name, index_name)
# Display the index_meta information about the search index. 
print(index_meta)
# Display the data synchronization status of the search index. 
print(sync_stat)

References

If existing search indexes do not meet your business requirements, you can create search indexes or modify the schemas of existing search indexes to add, remove, and modify index columns. For more information, see Create search indexes and Dynamically modify the schema of a search index.