SDK for C++接口说明

最近更新时间:2020-05-21 10:48:49

简介

TcaplusDB 服务化 API 是应用访问游戏数据库 TcaplusDB 的数据访问入口,是应用存取游戏数据库 TcaplusDB 中业务数据的编程接口。当前 TcaplusDB 主要使用基于 Google Protocol Buffer(Protobuf) 做通讯和数据元定义协议。

流程

您在 控制台 开通业务创建完表后,详情页会提供接入ID,访问密码,内网 IP 地址,以及 Protobuf 表管理页会提供已经创建的表名称和表格组 ID 等信息。使用 TcaplusDB C++ API,应用可以操作属于此集群下的多个表。

模块

您可以使用 Protobuf 协议来定义符合 TcaplusDB 规范的表,将表定义的元文件传到 TcaplusDB 控制台中进行创建新表或修改已经存在的表,成功后即可通过 TcaplusDB Protobuf API 进行表数据记录的读写操作,当前 TcaplusDB Protobuf API 支持的操作如下表:

操作 功能描述
GET 根据单个的字段获得单条 Value 信息
BATCHGET 根据多个的字段获得多条 Value 信息
ADD 插入一条数据,如果字段对应记录存在则报错
SET 字段对应记录存在则更新数据,否则插入数据请求
DEL 根据字段删除对应的记录
FIELDINC 指定字段的值(整数型)增加指定值
FIELDSET 更新指定字段(单个或多个)的值
FIELDGET 获取指定字段(单个或多个)的值
INDEXGET 指定索引和字段进行索引查询
TRAVERSE 指定表名进行全表遍历

TcaplusDB SDK 约定

TcaplusDB 需要定义表的主键字段等信息,扩展 tcaplusservice.optionv1.proto 存在于 TcaplusDB 系统中,您只需在自定义表时引用,创建新表或修改已经存在的表时不用上传,系统已经内置。具体内容如下:

extend google.protobuf.MessageOptions
{
    optional string tcaplus_primary_key             = 60000; //定义表的主键
    repeated string tcaplus_index                   = 60001; //定义表的索引
    optional string tcaplus_field_cipher_suite      = 60002; //定义表的字段使用的加密算法
    optional string tcaplus_record_cipher_suite     = 60003; //定义表的字段使用的加密算法,暂时未使用
    optional string tcaplus_cipher_md5              = 60004; //用于返回 cipher 字段信息摘要
    optional string tcaplus_sharding_key            = 60005; //Tcaplus sharding key
}

extend google.protobuf.FieldOptions
{
    optional uint32 tcaplus_size                    = 60000; // 字段大小,暂时未使用
    optional string tcaplus_desc                    = 60001; // 字段描述
    optional bool tcaplus_crypto                    = 60002; // 是否加密字段,加密算法由 tcaplus_field_cipher_suite 定义
}

完整文件可在目录 release\x86_64\include\tcaplus_pb_api\tcaplusservice.optionv1.proto 中找到。

  1. 表名要以字母或下划线开头,不能超过31个字段,不能有除数字,字母,下划线之外的特殊字段。
  2. 各字段的名称要以字母或下划线命名,protobuf 已经限制。
  3. 主键最多4个字段,必须是 required 类型,打包后长度不能超过1022字节。
  4. 字段值打包后不能超过256KB, 同时整个记录打包不能超过256KB。
  5. 除了主键字段,至少有一个 普通字段。
  6. 表默认是 generic 类型。但对外不显示 generic 类型。
  7. 主键字段当前只能是 protobuf 规定的标量类型(Scalar Value Type),不能包括其它复合类型,自定义类型等。

常用接口说明

  • int Get(::google::protobuf::Message &msg);

    @brief 根据用户输入 req 中的 index 名称,msg 值,offset 以及 limit,通过索引获取多个记录的值填充到 res 中的 vec 结构中,并返回总记录数以及剩余记录数
    @param [INOUT] req   用户输入的 req
    @param [INOUT] res   用户输入的 res
    @retval <0   失败,返回对应的错误码
    @retval 0    成功
  • int BatchGet(std::vector< ::google::protobuf::Message * > &msgs);

    @brief 根据用户输入 msgs 中的字段值,批量获取 msg 消息的字段值,并填充到 msgs 中
    @param [INOUT] msgs 用户输入的字段列表,返回指定字段填到 msgs 中
    @retval <0   失败,返回对应的错误码
    @retval 0    成功,至少有一个字段查询成功才会返回 0
  • int Add(::google::protobuf::Message *msg);

    @brief 根据用户输入 msg 中的字段,插入 msg 数据记录,如果字段存在报错退出
    @param [INOUT] msg   用户输入的字段值,以及需要插入的数据记录msg
    @retval <0   失败,返回对应的错误码
    @retval 0    成功
  • int Set(const ::google::protobuf::Message &msg);

    @brief 根据用户输入 msg 中的字段,如果记录存在更新指定记录的值,否则插入指定记录
    @param [INOUT] msg   用户输入的字段值,以及需要设置的数据记录 msg
    @retval <0   失败,返回对应的错误码
    @retval 0    成功
  • int Del(const ::google::protobuf::Message &msg);

    @brief 根据用户输入 msg 中的字段值,删除 msg       
    @param [IN] msg   用户输入的字段值,返回指定字段填到 msg 中
    @retval <0   失败,返回对应的错误码
    @retval 0    成功,至少有一个字段查询成功才会返回 0
  • int FieldInc(::google::protobuf::Message &msg, const std::set &dottedpaths);

    @brief 根据用户输入 msg 中的字段值和 values 增量值,和 dottedpaths 指定的字段名称,增加 msg 指定字段的值。字段为数值型变量
    @param [INOUT] msg   数据记录 msg,包含用户输入的字段值,返回增量字段的结果值更新到 msg 中
    @param [IN] dottedpaths 字段名称的点分嵌套字符串集
    @retval <0   失败,返回对应的错误码,表示没有任何字段更新
    @retval 0    成功,全部字段更新成功
  • int FieldGet(const std::set<std::string> &dottedpaths, ::google::protobuf::Message *msg, std::set<std::string> *failedpaths);

    @brief 根据用户输入 msg 中的字段值,和 dottedpaths 指定的字段名称,获取指定字段的值,并填充到 msg 中
    @param [INOUT] msg   数据记录 msg,包含用户输入的字段值,返回指定字段填到 msg 中
    @param [IN] dottedpaths 字段名称的点分嵌套字符串集
    @param [OUT] failedpaths 返回查找失败的字段名称的点分嵌套字符串集
    @retval <0   失败,返回对应的错误码
    @retval 0    成功,至少有一个字段查询成功才会返回0
  • int FieldSet(::google::protobuf::Message &msg, const std::set &dottedpaths);

    @brief 根据用户输入的 msg 中的 字段值,和 dottedpaths 指定的字段名称,更新指定字段的值。服务端不存在的值会追加进去
    @param [IN] msg 用户输入的字段值,返回指定字段填到 msg 中
    @param [IN] dottedpaths 字段名称的点分嵌套字符串集
    @retval <0   失败,返回对应的错误码,表示没有任何字段更新
    @retval 0    成功,全部字段更新成功
  • int Get(NS_TCAPLUS_PROTOBUF_API::IndexGetRequest& req, NS_TCAPLUS_PROTOBUF_API::IndexGetResponse *res);

    @brief 根据用户输入 req 中的 index 名称,msg 值,offset 以及 limit,通过索引获取多个记录的值填充到 res 中的 vec 结构中,并返回总记录数以及剩余记录数
    @param [INOUT] req   用户输入的 req
    @param [INOUT] res   用户输入的 res
    @retval <0   失败,返回对应的错误码
    @retval 0    成功
  • int Traverse(::google::protobuf::Message *msg, TcaplusTraverseCallback *cb);

    @brief 遍历表,消息会填充到 msg 中
    @param [INOUT] msg   返回指定字段填到 msg 中
    @param [INOUT] cb   回调函数
    @retval <0   失败,返回对应的错误码
    @retval 0    遍历成功完成

规则与约束

Get 操作约束

  • 不能查询特定版本号的记录。
  • 如果待查询的字段原记录中不存在,则会返回字段默认值。

BatchGet 操作约束

  • 一个批量查询请求返回一个批量查询结果,批量查询的超时时间为10秒。
  • 批量查询结果记录数同请求中记录数,查询不存在或者查询失败的记录也会在结果集中存在一条空的记录,因此需要通过 FetchRecord 进行记录获取。
  • 批量查询结果集总大小不能超过256K,否则超过大小记录内容会无法返回,会返回空记录内容。
  • 批量查询结果集返回的顺序与请求的记录顺序不保证一致。

FieldInc 操作约束

  • message 中指定的字段的记录必须是存在。
  • dottedpaths 中指定的字段必须是数值类型。
  • dottedpaths 所在 set 中的元素个数总数不能起过128个。
  • dottedpaths 所在 set 中的每个元素的长度不能超过1023字节。
  • dottedpaths 所在 set 中的第个元素代表的字段嵌套不能超过32。

FieldGet 操作约束

  • dottedpaths 所在 set 中的元素个数总数不能起过128个。
  • dottedpaths 所在 set 中的每个元素的长度不能超过1023字节。
  • dottedpaths 所在 set 中的第个元素代表的字段嵌套不能超过32。

FieldSet 操作约束

  • dottedpaths 所在 set 中的元素个数总数不能起过128个。
  • dottedpaths 所在 set 中的每个元素的长度不能超过1023字节。
  • dottedpaths 所在 set 中的第个元素代表的字段嵌套不能超过32。

SDK 源文件目录结构

`-- release
    `-- x86_64
        |-- docs                                   文档目录
        |   `-- tcaplus
        |       `-- readme.txt                     本 C++ SDK 的使用描述指引文件
        |-- examples                               本 C++ SDK 使用的样例目录,分同步和异步两大部分,可以直接修改使用
        |-- include                                本 C++ SDK 的头文件目录
        |   `-- tcaplus_pb_api                     TcaplusDB PB API 头文件夹
        |       |-- cipher_suite_base.h            数据加密码算法套件基类
        |       |-- default_aes_cipher_suite.h     数据加密码算法套件默认实现类
        |       |-- tcaplus_async_pb_api.h         异步模式类的头文件,使用异步模式当中的 TcaplusAsyncPbApi 类
        |       |-- tcaplus_coroutine_pb_api.h     协程模式类的头文件,使用协程模式当中的 TcaplusCoroutinePbApi 类
        |       |-- tcaplus_error_code.h           错误码头文件,所有涉及的错误码均可以在这里找到对应的定义及描述
        |       |-- tcaplus_protobuf_api.h         API 汇总头文件,包含了其它头文件,只需引用这一个文件方便开发
        |       |-- tcaplus_protobuf_define.h      基础结构和宏定义头文件,包括 ClientOptions 结构和 MESSAGE_OPTION_* 宏定义
        |       |-- tcaplusservice.optionv1.pb.h   Tcaplus 表公共定义的 Protobuf 头文件
        |       `-- tcaplusservice.optionv1.proto  Tcaplus 表公共定义的 proto 源文件, 自定义表时需包含此文件
        |-- lib                                    本 C++ SDK 的库文件目录
        |   `-- libtcaplusprotobufapi.a            本 C++ SDK 的库文件, 程序最终链接库需包含
        `-- version                                本 C++ SDK 的版本记录文件
目录