テーブル情報の照会 - Tablestore SDK for Python - Tablestore - Alibaba Cloud ドキュメントセンター

Tablestore SDK for Python を使用して、テーブルのスキーマ、設定、暗号化設定、予約済みスループット、セカンダリインデックスを照会します。

前提条件

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

機能の説明

describe_table メソッドを呼び出してテーブルを照会します。このメソッドは、現在のテーブル情報を含む DescribeTableResponse を返します。

def describe_table(self, table_name)

次の例では、example_table を照会し、レスポンスの主要フィールドを出力します。

response = client.describe_table("example_table")

print("Table metadata:", response.table_meta)
print("Table options:", response.table_options)
print("Encryption settings:", response.sse_details)
print(
    "Reserved throughput:",
    response.reserved_throughput_details,
)
print("Secondary indexes:", response.secondary_indexes)

パラメーター

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

名前	タイプ	説明
table_name (必須)	`str`	テーブルの名前。

レスポンス

DescribeTableResponse には、次の情報が含まれています。

フィールド	タイプ	説明
table_meta	`TableMeta`	テーブルスキーマ。テーブル名、プライマリキー列、事前定義列などが含まれます。
table_options	`TableOptions`	テーブルオプション。TTL、最大バージョン数、最大バージョン偏差、更新の可否などが含まれます。
reserved_throughput_details	`ReservedThroughputDetails`	現在の予約済みスループット、最終増加時刻、最終減少時刻などが含まれます。
secondary_indexes	`List[SecondaryIndexMeta]`	セカンダリインデックスのメタデータ。インデックス名、プライマリキー列、事前定義列、インデックスタイプなどが含まれます。
sse_details	`SSEDetails`	サーバー側の暗号化設定。有効化ステータス、キータイプ、キー ID、RAM ロール ARN などが含まれます。