Table Store Java SDK 查詢映射表資訊 - Tablestore

通過 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	欄位的附加資訊。