すべてのプロダクト
Search
ドキュメントセンター

Tablestore:マッピングテーブル情報の照会

最終更新日:Aug 07, 2026

Tablestore SDK for Python を使用して、マッピングテーブルのフィールド名、フィールドタイプ、プライマリキー情報を照会します。

前提条件

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

  • SQL クエリにはバージョン 5.4.2 以降が必要です。最新バージョンの使用を推奨します。

説明

exe_sql_query メソッドを呼び出して DESCRIBE 文を実行し、マッピングテーブルのフィールド名、フィールドタイプ、プライマリキー情報、NULL 許容、その他のスキーマ情報を照会します。

def exe_sql_query(self, query)

次の例では、example_table のスキーマを照会します。

query = "DESCRIBE example_table"
row_list, _, _ = client.exe_sql_query(query)

for row in row_list:
    print(dict(row.attribute_columns))

パラメーター

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

名前

タイプ

説明

query (必須)

String

実行する DESCRIBE <mapping_table_name> 文です。<mapping_table_name> はマッピングテーブル名です。

レスポンス

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

要素

タイプ

説明

row_list

List[Row]

マッピングテーブルのフィールドのリスト。各 Row オブジェクトには、次の結果セットフィールドが含まれます。

table_capacity_units

List[タプル]

データテーブルで消費された読み取りおよび書き込みのキャパシティーユニット (CU)。各タプルには、テーブル名と CapacityUnit オブジェクトが含まれます。

search_capacity_units

List[タプル]

検索インデックスで消費された読み取りおよび書き込みのキャパシティーユニット (CU)。各タプルには、検索インデックス名と CapacityUnit オブジェクトが含まれます。

結果セットフィールド

フィールド

タイプ

説明

Field

String

フィールド名。

Type

String

SQLフィールドタイプ。

Null

String

フィールドがNULL値を許容するかどうか。

Key

String

フィールドがプライマリキーかどうか。プライマリキー列の場合は PRI が返されます。

Default

String

デフォルト値。

Extra

String

追加のフィールド情報。