マッピングテーブルのインデックス情報のクエリ - Tablestore SDK for Python - Tablestore

前提条件

Tablestore SDK for Python をインストールし、クライアントを初期化します。
SQL クエリにはバージョン 5.4.2 以降が必要です。最新バージョンの使用を推奨します。

説明

exe_sql_query メソッドを呼び出して SHOW INDEX 文を実行し、マッピングテーブルのプライマリキーおよび関連インデックスをクエリします。

def exe_sql_query(self, query)

説明

データテーブルマッピングの場合、結果にはプライマリキーと、データテーブル上のセカンダリインデックスおよび検索インデックスのフィールドが含まれます。検索インデックスマッピングの場合、結果には指定された検索インデックスのプライマリキーとフィールドのみが含まれます。

次の例では、example_search_table のインデックス情報をクエリします。

query = "SHOW INDEX IN example_search_table"
row_list, _, _ = client.exe_sql_query(query)

for row in row_list:
    values = dict(row.attribute_columns)
    print(values["Key_name"], values["Column_name"], values["Index_type"])

パラメーター

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

名前	タイプ	説明
query (必須)	String	実行する `SHOW INDEX IN <mapping_table_name>` 文で、`<mapping_table_name>` はマッピングテーブル名です。

応答

exe_sql_query メソッドは、次の要素を含むタプルを返します。

要素	タイプ	説明
`row_list`	List[Row]	インデックスフィールドのリスト。各行は、プライマリキー、セカンダリインデックス、または検索インデックスのフィールドに対応します。
`table_capacity_units`	List[Tuple]	データテーブルによって消費された読み取りおよび書き込みキャパシティーユニット。各タプルには、テーブル名と `CapacityUnit` オブジェクトが含まれます。
`search_capacity_units`	List[Tuple]	検索インデックスによって消費された読み取りおよび書き込みキャパシティーユニット。各タプルには、検索インデックス名と `CapacityUnit` オブジェクトが含まれます。

結果セットのフィールド

フィールド	タイプ	説明
`Table`	String	マッピングテーブル名。
`Non_unique`	Integer	重複するインデックス値が許可されているかどうか。`0` は不許可、`1` は許可を意味します。
`Key_name`	String	インデックス名。プライマリキーは `PRIMARY` を返します。
`Seq_in_index`	Integer	インデックス内のフィールド位置。1 から始まります。
`Column_name`	String	インデックスフィールド名。
`Is_defined_column`	String	フィールドがデータテーブルの事前定義列であるかどうか。
`Search_type`	String	The query type of a search index field.
`Collation`	String	インデックスフィールドの照合順序。
`Cardinality`	Integer	インデックス内の一意の値の推定数。
`Sub_part`	Integer	インデックスフィールドのプレフィックス長。
`Packed`	String	インデックスの圧縮方法。
`Null`	String	フィールドが null になり得るかどうか。
`Index_type`	String	インデックスタイプ。グローバルセカンダリインデックスは `GlobalIndex`、ローカルセカンダリインデックスは `LocalIndex`、検索インデックスは `SearchIndex` を返します。
`Comment`	String	インデックスの備考。
`Index_comment`	String	インデックスのコメント。
`Visible`	String	インデックスが可視であるかどうか。
`Expression`	String	インデックスの式。