查询表信息

更新时间:
复制 MD 格式

Go SDK 可查询数据表的表结构、表配置、Stream、加密、预留读写吞吐量和二级索引信息。

前提条件

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

功能说明

调用 DescribeTable 查询指定数据表的表结构和配置。

func (tableStoreClient *TableStoreClient) DescribeTable(request *DescribeTableRequest) (*DescribeTableResponse, error)

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

request := &tablestore.DescribeTableRequest{
    TableName: "example_table",
}

response, err := client.DescribeTable(request)
if err != nil {
    log.Fatal(err)
}

fmt.Println("Table metadata:", response.TableMeta)
fmt.Println("Table options:", response.TableOption)
fmt.Println("Stream details:", response.StreamDetails)
fmt.Println("Encryption details:", response.SSEDetails)
fmt.Println("Reserved throughput:", response.ReservedThroughput)
fmt.Println("Secondary indexes:", response.IndexMetas)

参数说明

DescribeTableRequest 包含以下参数。

名称

类型

说明

TableName(必选)

string

数据表名称。

返回值

DescribeTableResponse 包含以下业务信息。

字段

类型

说明

TableMeta

*TableMeta

表结构,包括数据表名称、主键列、预定义列和表 ID 等信息。

TableOption

*TableOption

表配置,包括数据生命周期、最大版本数、有效版本偏差、更新权限和整行更新配置。

ReservedThroughput

*ReservedThroughput

预留读写吞吐量。

StreamDetails

*StreamDetails

Stream 的启用状态、Stream ID、过期时间、最近启用时间和原始列等信息。

IndexMetas

[]*IndexMeta

二级索引信息。

SSEDetails

*SSEDetails

服务端加密的启用状态、密钥类型、密钥 ID 和 RAM 角色 ARN 等信息。