Utilisez le SDK Tablestore pour Python afin d'interroger les champs, les configurations, la durée de vie (TTL) et l'état de synchronisation des données d'un index de recherche.
Prérequis
Installez le SDK Tablestore pour Python et initialisez un client.
Description
Appelez la méthode describe_search_index pour interroger les configurations et l'état de synchronisation des données d'un index de recherche.
def describe_search_index(
self,
table_name,
index_name,
include_sync_stat=True,
)L'exemple suivant interroge l'index example_index de la table example_table et affiche sa durée de vie (TTL), ses champs d'index ainsi que la phase de synchronisation des données.
index_meta, sync_stat = client.describe_search_index(
"example_table",
"example_index",
)
print(index_meta.time_to_live)
for field_schema in index_meta.fields:
print(field_schema.field_name)
if sync_stat is not None:
print(sync_stat.sync_phase)Paramètres
La méthode describe_search_index accepte les paramètres suivants.
|
Nom |
Type |
Description |
|
table_name (obligatoire) |
|
Le nom de la table. |
|
index_name (obligatoire) |
|
Le nom de l'index de recherche. |
|
include_sync_stat (facultatif) |
|
Indique s'il faut renvoyer l'état de synchronisation des données. Valeur par défaut : |
Réponse
La méthode describe_search_index renvoie un tuple contenant les informations suivantes.
|
Champ |
Type |
Description |
|
index_meta |
|
Les champs de l'index, les paramètres de l'index, les paramètres de prétri et la durée de vie (TTL). |
|
sync_stat |
|
L'état de synchronisation des données. Si |
Métadonnées de l'index de recherche
L'objet index_meta est une instance de SearchIndexMeta qui contient les champs suivants.
|
Champ |
Type |
Description |
|
fields |
|
Les champs de l'index. Pour la structure de l'objet, consultez la rubrique Créer un index de recherche. |
|
index_setting |
|
Les paramètres de l'index. |
|
index_sort |
|
Les paramètres de prétri. |
|
time_to_live |
|
La durée de vie (TTL) des données de l'index, en secondes. Une valeur de |
État de synchronisation des données
L'objet sync_stat est une instance de SyncStat qui contient les champs suivants.
|
Champ |
Type |
Description |
|
sync_phase |
|
La phase de synchronisation des données. |
|
current_sync_timestamp |
|
L'horodatage actuel de la synchronisation des données. |