查询全局表信息

更新时间:
复制 MD 格式

Go SDK 可查询全局表状态以及成员物理表的位置、角色和数据同步状态等信息。

前提条件

安装Tablestore Go SDK并初始化客户端。全局表功能需要 1.9.0 及以上版本,建议使用最新版本。

功能说明

调用 DescribeGlobalTable 方法查询指定全局表的状态和成员物理表信息。

func (client *TableStoreClient) DescribeGlobalTable(request *DescribeGlobalTableRequest) (*DescribeGlobalTableResponse, error)

以下示例通过全局表 ID 查询全局表信息。

request := &tablestore.DescribeGlobalTableRequest{
    GlobalTableId:   "gt-01234567-89ab-cdef-0123-456789abcdef",
    GlobalTableName: "example_table",
}

response, err := client.DescribeGlobalTable(request)
if err != nil {
    log.Fatalf("DescribeGlobalTable failed: %v", err)
}
fmt.Println("GlobalTableId:", response.GlobalTableId)
fmt.Println("Status:", response.Status)

for _, table := range response.PhyTables {
    fmt.Printf("%s/%s status=%s role=%s\n",
        table.RegionId, table.InstanceName, *table.Status, table.Role)
}

参数说明

DescribeGlobalTableRequest 包含以下参数。

名称

类型

说明

GlobalTableName(必选)

string

全局表名称,必须与基础表名称相同。

GlobalTableId(可选)

string

全局表 ID。GlobalTableId 和 PhyTable 必须至少设置一个。

PhyTable(可选)

*PhyTable

用于通过成员物理表定位全局表。GlobalTableId 和 PhyTable 必须至少设置一个。

ReturnRpo(可选)

*bool

是否请求返回恢复点目标(RPO)信息。Go SDK 1.9.2 未将此参数发送到服务端,设置后不生效。

物理表定位条件

使用成员物理表定位全局表时,PhyTable 包含以下参数。

名称

类型

说明

RegionId(必选)

string

成员物理表所在地域 ID。

InstanceName(必选)

string

成员物理表所在实例名称。必须与当前客户端访问的实例一致。

TableName(必选)

string

成员物理表名称,必须与 GlobalTableName 相同。

返回值

DescribeGlobalTableResponse 包含以下字段。

字段

类型

说明

GlobalTableId

string

全局表 ID。

Status

GlobalTableStatus

全局表状态。

PhyTables

[]*PhyTable

成员物理表信息。按全局表 ID 查询时返回完整列表;按成员物理表定位时返回空列表,可使用返回的 GlobalTableId 再次查询完整信息。

ServeMode

ServeMode

服务模式。ServeMode_PrimarySecondary 表示主备模式,ServeMode_PeerToPeer 表示多活模式。

全局表状态

Status 的取值如下。

取值

说明

GlobalTableStatus_Init

初始化中。首次创建全局表后进入此状态。

GlobalTableStatus_Reconf

重新配置中。创建副本、同步存量数据或添加、更新、移除副本时可能进入此状态。

GlobalTableStatus_Active

已激活。

物理表信息

PhyTables[] 中每个元素的类型为 *PhyTable,包含以下可用字段。

字段

类型

说明

RegionId

string

物理表所在地域 ID。

InstanceName

string

物理表所在实例名称。

TableName

string

物理表名称。

Status

*PhyTableStatus

物理表状态。

StatusTimestamp

*int64

物理表状态更新时间戳。

Role

string

物理表角色。主备模式下可能为 primary、secondary 或 primary_eligible;多活模式下为 peer。

TableId

*string

物理表 ID。

Stage

*PhyTableSyncStage

数据同步阶段。

说明

Go SDK 1.9.2 不会为 Writable、RpoNanos、IsFailed 和 Message 字段赋值。判断成员是否可写时,请使用 Role 字段。

物理表状态

PhyTables[].Status 的取值如下。

取值

说明

PhyTableStatus_Pending

排队中,等待其他物理表配置完成。

PhyTableStatus_Init

初始化中。

PhyTableStatus_Syncdata

正在同步存量数据。

PhyTableStatus_Ready

数据同步完成,等待激活。

PhyTableStatus_Active

已激活。

PhyTableStatus_Unbinding

正在移除。

PhyTableStatus_Unbound

已移除。

数据同步阶段

PhyTables[].Stage 的取值如下。

取值

说明

PhyTableSyncStage_Init

正在初始化同步任务。

PhyTableSyncStage_Full

正在同步存量数据。

PhyTableSyncStage_Incr

正在同步增量数据。

场景示例

通过成员物理表定位全局表

如果未记录全局表 ID,可以通过成员物理表所在地域、实例和表名定位全局表。此查询仅返回全局表 ID,不返回成员物理表列表。获取 ID 后,请再次按全局表 ID 查询完整信息。

request := &tablestore.DescribeGlobalTableRequest{
    GlobalTableName: "example_table",
    PhyTable: &tablestore.PhyTable{
        RegionId:     "cn-hangzhou",
        InstanceName: "source-instance",
        TableName:    "example_table",
    },
}

response, err := client.DescribeGlobalTable(request)
if err != nil {
    log.Fatalf("DescribeGlobalTable failed: %v", err)
}
fmt.Println("GlobalTableId:", response.GlobalTableId)