Interroger les informations d'un index de recherche - SDK Tablestore pour Java - Tablestore

Prérequis

Avant de commencer, assurez-vous que :

Vous avez installé le SDK Tablestore pour Java et initialisé le client.
La table et l'index de recherche existent.

Description

Appelez la méthode describeSearchIndex pour récupérer la configuration et l'état d'un index de recherche dans une table.

public DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request)

L'exemple suivant interroge l'index example_index de la table example_table et affiche l'état de l'index, la phase de synchronisation, le TTL (Time To Live) ainsi que les noms des champs.

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

Paramètres

L'objet DescribeSearchIndexRequest contient les paramètres suivants :

Nom

Type

Description

tableName (obligatoire)

String

Nom de la table.

indexName (obligatoire)

String

Nom de l'index de recherche.

includeSyncStat (facultatif)

Boolean

Indique s'il faut renvoyer la progression de la synchronisation des données. Valeur par défaut : true. Si ce paramètre est défini sur false, le champ syncStat de la réponse est null.

Réponse

L'objet DescribeSearchIndexResponse contient les champs suivants :

Champ

Type

Description

schema

IndexSchema

Appelez la méthode getSchema() pour récupérer les champs de l'index, ses paramètres et les paramètres de prétri. Pour la structure de l'objet, consultez la rubrique Créer un index de recherche.

syncStat

SyncStat

Appelez la méthode getSyncStat() pour récupérer la progression de la synchronisation des données. Si includeSyncStat est défini sur false, ce champ est null.

meteringInfo

MeteringInfo

Appelez la méthode getMeteringInfo() pour récupérer les dernières informations de facturation.

brotherIndexName

String

Appelez la méthode getBrotherIndexName() pour récupérer le nom de l'index associé. Si l'index de recherche n'a aucun index associé, ce champ est null.

queryFlowWeight

List<QueryFlowWeight>

Appelez la méthode getQueryFlowWeight() pour récupérer les poids du trafic de requête. Si aucun poids n'est configuré, ce champ est null.

createTime

Long

Appelez la méthode getCreateTime() pour récupérer l'heure de création de l'index de recherche.

indexStatus

IndexStatus

Appelez la méthode getIndexStatus() pour récupérer l'état de l'index de recherche et sa description.

timeToLive

Integer

Appelez la méthode getTimeToLive() pour récupérer le TTL (Time To Live) des données de l'index, en secondes. Une valeur de -1 indique que les données n'expirent pas.

Progression de la synchronisation des données

Le champ syncStat est de type SyncStat et contient les champs suivants :

Champ

Type

Description

syncPhase

SyncPhase

Appelez la méthode getSyncPhase() pour récupérer la phase de synchronisation. La valeur FULL indique une synchronisation complète, tandis que INCR indique une synchronisation incrémentielle.

currentSyncTimestamp

Long

Appelez la méthode getCurrentSyncTimestamp() pour récupérer l'horodatage actuel de la synchronisation.

Informations de facturation

Le champ meteringInfo est de type MeteringInfo et contient les champs suivants :

Champ

Type

Description

reservedThroughput

ReservedThroughput

Appelez la méthode getReservedThroughput().getCapacityUnit().getReadCapacityUnit() pour récupérer le débit de lecture réservé.

storageSize

long

Appelez la méthode getStorageSize() pour récupérer la taille de stockage de l'index au moment de la dernière mesure de facturation.

rowCount

long

Appelez la méthode getRowCount() pour récupérer le nombre total de lignes d'index au moment de la dernière mesure de facturation.

timestamp

long

Appelez la méthode getTimestamp() pour récupérer l'horodatage de la dernière mesure de facturation.

Poids du trafic de requête

Chaque élément du tableau queryFlowWeight[] est de type QueryFlowWeight et contient les champs suivants :

Champ

Type

Description

indexName

String

Appelez la méthode getIndexName() pour récupérer le nom de l'index de recherche.

weight

Integer

Appelez la méthode getWeight() pour récupérer le poids du trafic de requête. Valeurs valides : de 0 à 100.

État de l'index

Le champ indexStatus est de type IndexStatus et contient les champs suivants :

Champ

Type

Description

indexStatusEnum

IndexStatusEnum

État de l'index. Valeurs valides : PENDING, FAILED, RUNNING et UNKNOWN.

statusDescription

String

Description de l'état de l'index.