【TcaplusDB知识库】Tcaplus Go SDK手册(一)

2022-04-11 00:00:00 源码 记录 响应 接口 赋值

1 使用准备

本API是Tcaplus API的Go封装,支持Generic表的增删改查

1.1 各代码目录

  • pack为打包脚本
  • example为示例
  • aurotest为测试工具
  • 其他目录为Tcaplus Go API的源码
  • vendor 中为依赖库的代码,需要使用git submodule init和git submodule update拉取

1.2 编译example

example/generic_table展示了对service_info表的insert get replace update delete操作

  1. Go环境安装https://golang.org/
  2. 将service_info.xml加入Tcaplus
  3. 修改main.go的开头的AppId ZoneId DirUrl Signature为相应的Tcaplus配置信息
  4. make之后执行

1.3 打包脚本

pack/pack.sh展示了对源码及依赖库的打包,方便用户移植到无法使用go mod的场景

  1. cd pack && sh pack.sh

2 API的使用

2.1 vendor方式使用

Tcaplus API的依赖库及其源码都在打包后的src/vendor目录下,用户只需将vendor放入自己的工程目录即可使用Tcaplus Go API的接口

vendor依赖介绍:

  • http://github.com/tencentyun/tcaplusdb-go-sdk/tdr是Tcaplus Go API源码
  • http://github.com/tencentyun/tsf4g/TdrCodeGen是tdr工具,可将tdr的xml转换为go源码
  • http://github.com/tencentyun/tsf4g/tdrcom是tdr go源码打解包的依赖库
  • http://go.uber.org/zap是日志库
  • http://github.com/natefinch/lumberjack是日志文件切割库

2.2 mod 方式使用

mod 模式需要在能连内网及公网环境下使用

  • 在工程中建立go.mod
  • 开启module模式
  • 执行命令go clean --modcache
  • 执行命令 go mod edit -require="http://github.com/tencentyun/tcaplusdb-go-sdk/tdr@v0.1.0"

3 接口使用步骤

对表中的record的操作有两套接口:

  • 一套使用SetKey SetValue接口对record赋值,由用户指定key字段和value字段的内容,响应消息只能通过GetKey,GetValue接口读取
  • 另一套使用SetData接口对record赋值,用户赋值Tdr结构体,SetData通过反射对record赋值,响应消息只能通过GetData接口读取

3.1 SetKey和SetValue方式使用

1 通过tcaplus.NewClient()创建一个tcaplus客户端指针

client := tcaplus.NewClient()

相关文章