Consulta de información del índice de búsqueda - Tablestore - Centro de documentación de Alibaba Cloud

Use Tablestore SDK for Python para consultar los campos, las configuraciones, el TTL y el estado de sincronización de datos de un índice de búsqueda.

Requisitos previos

Instale Tablestore SDK for Python e inicialice un cliente.

Descripción

Llame a describe_search_index para consultar las configuraciones y el estado de sincronización de datos de un índice de búsqueda.

def describe_search_index(
    self,
    table_name,
    index_name,
    include_sync_stat=True,
)

El siguiente ejemplo consulta example_index de example_table e imprime su TTL, los campos del índice y la fase de sincronización de datos.

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)

Parámetros

El método describe_search_index incluye los siguientes parámetros.

Nombre	Tipo	Descripción
table_name (obligatorio)	`str`	Nombre de la tabla.
index_name (obligatorio)	`str`	Nombre del índice de búsqueda.
include_sync_stat (opcional)	`bool`	Especifica si se devuelve el estado de sincronización de datos. Valor predeterminado: `True`. Si establece este parámetro en `False`, `sync_stat` en la respuesta es `None`.

Respuesta

El método describe_search_index devuelve una tupla con la siguiente información.

Campo	Tipo	Descripción
index_meta	`SearchIndexMeta`	Campos del índice, configuración del índice, configuración de preordenamiento y TTL.
sync_stat	`SyncStat`	Estado de sincronización de datos. Si `include_sync_stat` es `False`, este campo es `None`.

Metadatos del índice de búsqueda

index_meta es un objeto SearchIndexMeta que contiene los siguientes campos.

Campo	Tipo	Descripción
fields	`List[FieldSchema]`	Campos del índice. Para consultar la estructura del objeto, consulte Create a search index.
index_setting	`IndexSetting`	Configuración del índice.
index_sort	`Sort`	Configuración de preordenamiento.
time_to_live	`int`	TTL de los datos del índice en segundos. Un valor de `-1` indica que los datos no caducan.

Estado de sincronización de datos

sync_stat es un objeto SyncStat que contiene los siguientes campos.

Campo	Tipo	Descripción
sync_phase	`SyncPhase`	Fase de sincronización de datos. `FULL` indica sincronización completa y `INCR` indica sincronización incremental.
current_sync_timestamp	`int`	Marca de tiempo actual de la sincronización de datos.