検索インデックスの構成と同期ステータスのクエリ - Tablestore SDK for Python - Tablestore

Tablestore SDK for Python を使用して、検索インデックスのフィールド、構成、Time To Live (TTL)、およびデータ同期ステータスをクエリします。

前提条件

Tablestore SDK for Python をインストールし、クライアントを初期化します。

説明

describe_search_index を呼び出して、検索インデックスの構成とデータ同期ステータスをクエリします。

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

次の例では、example_table の example_index をクエリし、その TTL、インデックスフィールド、および同期フェーズを出力します。

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)

パラメーター

describe_search_index メソッドには、次のパラメーターが含まれます。

名前	型	説明
table_name (必須)	`str`	テーブル名。
index_name (必須)	`str`	検索インデックス名。
include_sync_stat (オプション)	`bool`	データ同期ステータスを返すかどうかを指定します。デフォルト値: `True`。このパラメーターを `False` に設定した場合、レスポンスの `sync_stat` は `None` になります。

レスポンス

describe_search_index メソッドは、次の情報を含むタプルを返します。

フィールド	型	説明
index_meta	`SearchIndexMeta`	インデックスフィールド、インデックス設定、事前ソート設定、および TTL。
sync_stat	`SyncStat`	データ同期ステータス。 `include_sync_stat` が `False` の場合、このフィールドは `None` になります。

検索インデックスのメタデータ

index_meta は、次のフィールドを含む SearchIndexMeta オブジェクトです。

フィールド	型	説明
fields	`List[FieldSchema]`	インデックスフィールド。オブジェクト構造については、「検索インデックスの作成」をご参照ください。
index_setting	`IndexSetting`	インデックス設定。
index_sort	`Sort`	事前ソート設定。
time_to_live	`int`	インデックスデータの TTL (秒単位)。値が `-1` の場合、データは期限切れになりません。

データ同期ステータス

sync_stat は、次のフィールドを含む SyncStat オブジェクトです。

フィールド	型	説明
sync_phase	`SyncPhase`	同期フェーズ。`FULL` は完全同期を示し、`INCR` は増分同期を示します。
current_sync_timestamp	`int`	現在のデータ同期タイムスタンプ。