Consultar configurações e status de sincronização do índice de pesquisa - Tablestore SDK for Python - Tablestore: Central de Documentação do Alibaba Cloud

Use o Tablestore SDK for Python para consultar os campos, as configurações, o TTL e o status de sincronização de dados de um índice de pesquisa.

Pré-requisitos

Instale o Tablestore SDK for Python e inicialize um cliente.

Descrição

Chame describe_search_index para consultar as configurações e o status de sincronização de dados de um índice de pesquisa.

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

O exemplo a seguir consulta example_index em example_table e imprime o TTL, os campos do índice e a fase de sincronização de dados.

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

O método describe_search_index contém os seguintes parâmetros.

Nome	Tipo	Descrição
table_name (obrigatório)	`str`	Nome da tabela.
index_name (obrigatório)	`str`	Nome do índice de pesquisa.
include_sync_stat (opcional)	`bool`	Defina se o status de sincronização de dados deve ser retornado. Valor padrão: `True`. Se definido como `False`, `sync_stat` na resposta será `None`.

Resposta

O método describe_search_index retorna uma tupla com as seguintes informações.

Campo	Tipo	Descrição
index_meta	`SearchIndexMeta`	Campos do índice, configurações do índice, definições de pré-ordenação e TTL.
sync_stat	`SyncStat`	Status de sincronização de dados. Se `include_sync_stat` for `False`, este campo será `None`.

Metadados do índice de pesquisa

index_meta é um objeto SearchIndexMeta que contém os seguintes campos.

Campo	Tipo	Descrição
fields	`List[FieldSchema]`	Campos do índice. Para a estrutura do objeto, consulte Crie um índice de pesquisa.
index_setting	`IndexSetting`	Configurações do índice.
index_sort	`Sort`	Definições de pré-ordenação.
time_to_live	`int`	TTL dos dados do índice em segundos. O valor `-1` indica que os dados não expiram.

Status de sincronização de dados

sync_stat é um objeto SyncStat que contém os seguintes campos.

Campo	Tipo	Descrição
sync_phase	`SyncPhase`	Fase de sincronização de dados. `FULL` representa sincronização completa; `INCR` indica sincronização incremental.
current_sync_timestamp	`int`	Timestamp atual da sincronização de dados.