表格存储 Java SDK 查询映射表信息 - 表格存储

通过 Java SDK 查询映射表的字段名称、字段类型、主键信息和空值约束等结构信息。

前提条件

安装Tablestore Java SDK并初始化客户端。
使用 5.13.0 及以上版本的 Tablestore Java SDK。

功能说明

调用 sqlQuery 方法执行 DESCRIBE 语句，查询指定映射表的字段结构。

SQLQueryResponse sqlQuery(SQLQueryRequest request)

以下示例查询 example_table 映射表的字段结构，并按字段名读取各项信息。

SQLQueryRequest request =
        new SQLQueryRequest("DESCRIBE example_table");
SQLQueryResponse response = client.sqlQuery(request);

SQLResultSet resultSet = response.getSQLResultSet();
while (resultSet.hasNext()) {
    SQLRow row = resultSet.next();
    System.out.println(
            row.getString("Field") + ", "
                    + row.getString("Type") + ", "
                    + row.getString("Null") + ", "
                    + row.getString("Key") + ", "
                    + row.getString("Default") + ", "
                    + row.getString("Extra"));
}

参数说明

SQLQueryRequest 包含以下参数。

名称	类型	说明
query（必选）	String	要执行的 `DESCRIBE <mapping_table_name>` 语句，其中 `mapping_table_name` 为映射表名称。

返回值

SQLQueryResponse 包含以下与映射表结构相关的字段。

字段	类型	说明
`type`	SQLStatementType	通过 `getSQLStatementType()` 获取 SQL 语句类型。执行 `DESCRIBE` 语句时返回 `SQL_DESCRIBE_TABLE`。
`rows`	ByteString	映射表结构的序列化数据。通过 `getSQLResultSet()` 获取解析后的 `SQLResultSet`。

结果集字段

SQLResultSet 中的每一行对应映射表中的一个字段，包含以下列。

字段	类型	说明
`Field`	String	字段名称。
`Type`	String	字段的 SQL 数据类型。
`Null`	String	字段是否允许为空。取值为 `YES` 或 `NO`。
`Key`	String	字段的键类型。主键字段返回 `PRI`。
`Default`	String	字段的默认值。未设置默认值时返回 `null`。
`Extra`	String	字段的附加信息。