查询映射表信息

更新时间:
复制 MD 格式

通过 Python SDK 查询映射表的字段名称、字段类型和主键信息。

前提条件

  • 安装Tablestore Python SDK并初始化客户端。

  • SQL 查询功能需要使用 5.4.2 及以上版本,建议使用最新版本。

功能说明

调用 exe_sql_query 方法执行 DESCRIBE 语句,查询映射表的字段名称、字段类型、主键信息和是否允许为空等 Schema 信息。

def exe_sql_query(self, query)

以下示例查询 example_table 的 Schema。

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[Tuple]

各数据表消耗的读写 CU。每个元组包含数据表名称和 CapacityUnit 对象。

search_capacity_units

List[Tuple]

各多元索引消耗的读写 CU。每个元组包含多元索引名称和 CapacityUnit 对象。

结果集字段

字段

类型

说明

Field

String

字段名称。

Type

String

SQL 字段类型。

Null

String

字段是否允许为空。

Key

String

字段是否为主键。主键列返回 PRI。

Default

String

字段默认值。

Extra

String

字段的其他信息。