表格存储 Java SDK 查询表信息-表格存储 Tablestore(Tablestore)-阿里云帮助中心

前提条件

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

功能说明

调用 describeTable 查询指定数据表的表结构、表配置、Stream、服务端加密、预留读写吞吐量和二级索引等信息。

public DescribeTableResponse describeTable(DescribeTableRequest request) throws TableStoreException, ClientException

以下示例查询 example_table 的表信息并输出主要返回内容。

DescribeTableRequest request = new DescribeTableRequest("example_table");
DescribeTableResponse response = client.describeTable(request);

System.out.println("Table metadata: " + response.getTableMeta());
System.out.println("Table options: " + response.getTableOptions());
System.out.println("Stream details: " + response.getStreamDetails());
SSEDetails sseDetails = response.getSseDetails();
System.out.println("Encryption enabled: " + sseDetails.isEnable());
if (sseDetails.isEnable()) {
    System.out.println("Encryption type: " + sseDetails.getKeyType());
}
System.out.println("Reserved throughput: " + response.getReservedThroughputDetails());
System.out.println("Secondary indexes: " + response.getIndexMeta());
System.out.println("Partition split points: " + response.getShardSplits());
System.out.println("Creation time: " + response.getCreationTime());

参数说明

DescribeTableRequest 包含以下参数。

名称	类型	说明
tableName（必选）	`String`	数据表名称。

返回值

DescribeTableResponse 包含以下返回信息。

字段	类型	说明
`tableMeta`	`TableMeta`	通过 `getTableMeta()` 获取数据表结构，包括数据表名称、主键列、预定义列和表 ID 等信息。
`reservedThroughputDetails`	`ReservedThroughputDetails`	通过 `getReservedThroughputDetails()` 获取当前预留读写吞吐量，以及最近一次上调和下调的时间。
`tableOptions`	`TableOptions`	通过 `getTableOptions()` 获取表配置，包括数据生命周期、最大版本数、有效版本偏差、是否允许更新和是否整行更新。
`shardSplits`	`List<PrimaryKey>`	通过 `getShardSplits()` 获取数据分片之间的分割点。
`streamDetails`	`StreamDetails`	通过 `getStreamDetails()` 获取 Stream 配置，包括启用状态、Stream ID、过期时间、最近启用时间和原始列。
`sseDetails`	`SSEDetails`	通过 `getSseDetails()` 获取服务端加密配置，包括启用状态、密钥类型、密钥 ID 和 RAM 角色 ARN。
`indexMeta`	`List<IndexMeta>`	通过 `getIndexMeta()` 获取二级索引信息，包括索引名称、主键列、预定义列、索引类型、更新模式和同步阶段。
`creationTime`	`long`	通过 `getCreationTime()` 获取数据表创建时间，单位为微秒。