Query search index information - Tablestore SDK for Java - Tablestore

Tablestore SDK for Java recupera el esquema, el progreso de sincronización de datos, la información de medición y el estado de un índice de búsqueda.

Requisitos previos

Antes de empezar, asegúrese de que:

Ha instalado Tablestore SDK for Java e inicializado el cliente.
La tabla y el índice de búsqueda existen.

Descripción

Llame a describeSearchIndex para recuperar la configuración y el estado de un índice de búsqueda en una tabla.

public DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request)

El siguiente ejemplo consulta example_index para example_table e imprime el estado del índice, la fase de sincronización, el TTL y los nombres de los campos.

String tableName = "example_table";
String indexName = "example_index";
DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
request.setTableName(tableName);
request.setIndexName(indexName);
request.setIncludeSyncStat(true);

DescribeSearchIndexResponse response = client.describeSearchIndex(request);
System.out.println(response.getIndexStatus().indexStatusEnum);
System.out.println(response.getSyncStat().getSyncPhase());
System.out.println(response.getTimeToLive());
for (FieldSchema fieldSchema : response.getSchema().getFieldSchemas()) {
    System.out.println(fieldSchema.getFieldName());
}

Parámetros

DescribeSearchIndexRequest contiene los siguientes parámetros:

Nombre	Tipo	Descripción
tableName (obligatorio)	`String`	El nombre de la tabla.
indexName (obligatorio)	`String`	El nombre del índice de búsqueda.
includeSyncStat (opcional)	`Boolean`	Especifica si se debe devolver el progreso de sincronización de datos. Valor predeterminado: `true`. Si este parámetro se establece en `false`, `syncStat` en la respuesta es `null`.

Respuesta

DescribeSearchIndexResponse contiene los siguientes campos:

Campo	Tipo	Descripción
`schema`	`IndexSchema`	Llame a `getSchema()` para recuperar los campos del índice, la configuración del índice y la configuración de preordenamiento. Para consultar la estructura del objeto, consulte Create a search index.
`syncStat`	`SyncStat`	Llame a `getSyncStat()` para recuperar el progreso de sincronización de datos. Si `includeSyncStat` es `false`, este campo es `null`.
`meteringInfo`	`MeteringInfo`	Llame a `getMeteringInfo()` para recuperar la información de medición más reciente.
`brotherIndexName`	`String`	Llame a `getBrotherIndexName()` para recuperar el nombre del índice asociado. Si el índice de búsqueda no tiene un índice asociado, este campo es `null`.
`queryFlowWeight`	`List<QueryFlowWeight>`	Llame a `getQueryFlowWeight()` para recuperar los pesos de tráfico de consulta. Si no hay pesos configurados, este campo es `null`.
`createTime`	`Long`	Llame a `getCreateTime()` para recuperar la hora de creación del índice de búsqueda.
`indexStatus`	`IndexStatus`	Llame a `getIndexStatus()` para recuperar el estado del índice de búsqueda y su descripción.
`timeToLive`	`Integer`	Llame a `getTimeToLive()` para recuperar el TTL de los datos del índice en segundos. Un valor de `-1` indica que los datos no caducan.

Progreso de sincronización de datos

syncStat es de tipo SyncStat y contiene los siguientes campos:

Campo	Tipo	Descripción
`syncPhase`	`SyncPhase`	Llame a `getSyncPhase()` para recuperar la fase de sincronización. `FULL` indica sincronización completa y `INCR` indica sincronización incremental.
`currentSyncTimestamp`	`Long`	Llame a `getCurrentSyncTimestamp()` para recuperar la marca de tiempo de sincronización actual.

Información de medición

meteringInfo es de tipo MeteringInfo y contiene los siguientes campos:

Campo	Tipo	Descripción
`reservedThroughput`	`ReservedThroughput`	Llame a `getReservedThroughput().getCapacityUnit().getReadCapacityUnit()` para recuperar el throughput de lectura reservado.
`storageSize`	`long`	Llame a `getStorageSize()` para recuperar el tamaño de almacenamiento del índice en la última medición.
`rowCount`	`long`	Llame a `getRowCount()` para recuperar el número total de filas del índice en la última medición.
`timestamp`	`long`	Llame a `getTimestamp()` para recuperar la marca de tiempo de la medición más reciente.

Pesos de tráfico de consulta

Cada elemento en queryFlowWeight[] es de tipo QueryFlowWeight y contiene los siguientes campos:

Campo	Tipo	Descripción
`indexName`	`String`	Llame a `getIndexName()` para recuperar el nombre del índice de búsqueda.
`weight`	`Integer`	Llame a `getWeight()` para recuperar el peso de tráfico de consulta. Valores válidos: 0 a 100.

Estado del índice

indexStatus es de tipo IndexStatus y contiene los siguientes campos:

Campo	Tipo	Descripción
`indexStatusEnum`	`IndexStatusEnum`	El estado del índice. Valores válidos: `PENDING`, `FAILED`, `RUNNING` y `UNKNOWN`.
`statusDescription`	`String`	La descripción del estado del índice.