Query search index information - Tablestore SDK for Java - Tablestore

Tablestore SDK for Java retrieves the schema, data synchronization progress, metering information, and status of a search index.

Prerequisites

Before you begin, make sure that:

You have installed the Tablestore SDK for Java and initialized the client.
The table and search index exist.

Description

Call describeSearchIndex to retrieve the configuration and status of a search index in a table.

public DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request)

The following example queries example_index for example_table and prints the index status, synchronization phase, TTL, and field names.

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());
}

Parameters

DescribeSearchIndexRequest contains the following parameters:

Name	Type	Description
tableName (required)	`String`	The table name.
indexName (required)	`String`	The search index name.
includeSyncStat (optional)	`Boolean`	Specifies whether to return data synchronization progress. Default value: `true`. If this parameter is set to `false`, `syncStat` in the response is `null`.

Response

DescribeSearchIndexResponse contains the following fields:

Field	Type	Description
`schema`	`IndexSchema`	Call `getSchema()` to retrieve the index fields, index settings, and presorting settings. For the object structure, see Create a search index.
`syncStat`	`SyncStat`	Call `getSyncStat()` to retrieve the data synchronization progress. If `includeSyncStat` is `false`, this field is `null`.
`meteringInfo`	`MeteringInfo`	Call `getMeteringInfo()` to retrieve the most recent metering information.
`brotherIndexName`	`String`	Call `getBrotherIndexName()` to retrieve the associated index name. If the search index has no associated index, this field is `null`.
`queryFlowWeight`	`List<QueryFlowWeight>`	Call `getQueryFlowWeight()` to retrieve the query traffic weights. If no weights are configured, this field is `null`.
`createTime`	`Long`	Call `getCreateTime()` to retrieve the search index creation time.
`indexStatus`	`IndexStatus`	Call `getIndexStatus()` to retrieve the search index status and status description.
`timeToLive`	`Integer`	Call `getTimeToLive()` to retrieve the index data TTL in seconds. A value of `-1` indicates that data does not expire.

Data synchronization progress

syncStat is of the SyncStat type and contains the following fields:

Field	Type	Description
`syncPhase`	`SyncPhase`	Call `getSyncPhase()` to retrieve the synchronization phase. `FULL` indicates full synchronization, and `INCR` indicates incremental synchronization.
`currentSyncTimestamp`	`Long`	Call `getCurrentSyncTimestamp()` to retrieve the current synchronization timestamp.

Metering information

meteringInfo is of the MeteringInfo type and contains the following fields:

Field	Type	Description
`reservedThroughput`	`ReservedThroughput`	Call `getReservedThroughput().getCapacityUnit().getReadCapacityUnit()` to retrieve the reserved read throughput.
`storageSize`	`long`	Call `getStorageSize()` to retrieve the index storage size at the most recent metering time.
`rowCount`	`long`	Call `getRowCount()` to retrieve the total number of index rows at the most recent metering time.
`timestamp`	`long`	Call `getTimestamp()` to retrieve the timestamp of the most recent metering.

Query traffic weights

Each element in queryFlowWeight[] is of the QueryFlowWeight type and contains the following fields:

Field	Type	Description
`indexName`	`String`	Call `getIndexName()` to retrieve the search index name.
`weight`	`Integer`	Call `getWeight()` to retrieve the query traffic weight. Valid values: 0 to 100.

Index status

indexStatus is of the IndexStatus type and contains the following fields:

Field	Type	Description
`indexStatusEnum`	`IndexStatusEnum`	The index status. Valid values: `PENDING`, `FAILED`, `RUNNING`, and `UNKNOWN`.
`statusDescription`	`String`	The index status description.