TcaplusDB TDR表 Go SDK 开始使用

使用Go SDK的前期准备工作主要包括：

准备环境；
创建业务；
创建游戏区；
创建表格；
收集环境信息；
下载SDK；
配置开发环境。

以上准备工作已经完成，可以直接跳过。

1. 准备环境

参考创建集群文档，部署TcaplusDB集群，或者申请TcaplusDB服务。

2. 创建业务

参考创建业务文档，创建业务（App）。

3. 创建游戏区

参考创建游戏区文档，创建游戏区（Zone）。

4. 创建表格

参考创建表格文档，创建数据表。

TDR表分为Generic表和List表两种。

4.1. Generic表定义说明

Generic表描述文件样例下载。

Generic表描述文件内容示例：

<?xml version="1.0" encoding="GBK" standalone="yes" ?>               
<metalib name="table_test" tagsetversion="1" version="1">               
    <struct name="test" version="1" splittablekey="gameid"  primarykey="gameid,itemid,name">               
        <entry name="gameid" type="uint" />                
        <entry name="itemid" type="uint" />               
        <entry name="name" type="string" size="5" />               
        <entry name="typeid" type="uint8"/>               
        <entry name="Data" type="tinyuint" defaultvalue="9"/>               
        <entry name="uname" type="string" size="5" defaultvalue="ab"/>               
        <index name="index_id" column="gameid" />               
    </struct>
</metalib>

TDR表描述文件格式说明参见TDR表文档。

4.2. List表定义说明

List表描述文件样例下载。

List表描述文件内容示例：

<?xml version="1.0" encoding="GBK" standalone="yes" ?>               
<metalib name="table_test" tagsetversion="1" version="1">               
    <struct name="test" version="1" splittablekey="gameid"  primarykey="gameid,itemid,name" customattr2="TableType=LIST;ListNum=3">               
        <entry name="gameid" type="uint" />                
        <entry name="itemid" type="uint" />               
        <entry name="name" type="string" size="5" />               
        <entry name="typeid" type="uint8"/>               
        <entry name="Data" type="tinyuint" defaultvalue="9"/>               
        <entry name="uname" type="string" size="5" defaultvalue="ab"/>               
        <index name="index_id" column="gameid" />               
    </struct>
</metalib>

TDR表描述文件格式说明参见TDR表文档。

通过表定义的customattr2中的TableType=LIST来标识是List表，同样通过customattr2中的ListNum属性来指定，单个List最多可以存放多少个元素。

注意：由于List表会内置一个存放List中元素序号的主键字段，因此对于用户来说，最多只能为List表定义7个主键字段。

5. 收集环境信息

使用SDK时，需要用到一些环境相关参数，具体参数和收集方法见下表。

参数	值	获取方法
目录服务器地址列表		获取目录服务地址列表
业务ID		获取业务ID
业务访问密码		获取业务访问密码
游戏区ID		获取游戏区ID
数据表名	test

6. 下载Go SDK

Go SDK发布版本说明和下载连接参见TDR表SDK下载。

7. 配置编译开发环境

环境依赖	版本	说明
Go	1.11以上	Go语言跨平台，推荐使用支持Go mod的版本；Go环境安装https://golang.org/
tsf4g	master下载	TDR相关依赖工具

7.1 TDR表XML文件转为go代码

下载 TdrCodeGen工具

python tdr.py table.xml
得到相应表的go源码目录table/table.go
将table.go放到自己的go的工程目录即可使用

7.2 编译

进入example目录直接make即可编译

# Go parameters
export GO111MODULE=on
export GOPATH:=${GOPATH}:$(shell pwd)/../../../../
GOCMD=go
GOBUILD=$(GOCMD) build
GOCLEAN=$(GOCMD) clean
BINARY_NAME=async

all: build
build:
    $(GOBUILD) -o $(BINARY_NAME) *.go
clean:
    $(GOCLEAN)
    rm -f $(BINARY_NAME)

example目录说明：

sync 是同步+多协程使用示例（推荐）
sync2.0 基于sync做了进一步优化封装，同步+option的方式，使用更简单（推荐）
async 是异步方式使用示例

8. 使用Go SDK

参见Go SDK各接口的使用说明。

9. 常见问题

使用SDK的过程中，有疑问（如查看SDK版本，配置SDK日志打印，升级SDK等），或者遇到报错，可参考“常见问题”和“错误码含义和处理方法”进行处理。

常见问题文档；
错误码含义和处理方法文档。

开始使用