OceanBase客户端使用指南.docx

OceanBase客户端使用指南
1 OceanBase客户端工作原理 3
2 客户端常用数据结构说明 3
rowkey 3
RowData 3
QueryInfo 3
InsertMutator和UpdateMutator 4
3 接口使用说明 4
初始化OceanBase java客户端 4
配置项 4
创建客户端实例 4
接口使用说明 5
ResultCode定义 5
get 5
query 5
insert 6
update 6
delete 6
本文档描述OceanBase客户端的使用方法,由于当前仅提供Java客户端,所以暂时只包含Java客户端的使用方法。
文档主要包括以下几个部分:
客户端的工作原理
客户端常用数据结构说明
客户端的初始化和接口使用说明
OceanBase客户端工作原理
OceanBase是一个分布式表格存储系统,主要包括以下模块:
rootserver
updateserver
chunkserver
mergeserver
rootserver负责维护系统数据的分布信息,客户端根据用户请求的rowkey,从rootserver查询负责该rowkey对应数据的mergeserver。
updateserver负责整个系统的数据更新,更新的数据会定期合并到chunkserver。
chunkserver负责静态数据的存储。
mergeserver提供系统的查询服务,当接收到查询时,mergeserver会根据相应的rowkey(或者范围)请求chunkserver上存储的静态数据,以及updateserver上更新的数据,然后做合并,返回结果数据。
mergeserver还支持对数据的过滤,排序等操作。
客户端常用数据结构说明
rowkey
OceanBase中所有的数据都需要有一个rowkey,数据在存储时按照rowkey排序。RowKey为字节流,rowkey的结构在系统的schema中指定。
RowData
OceanBase客户端使用RowData来表示一行数据,该数据结构通常用在查询返回时。数据结构包括:
表名
rowkey
各列数据,列的数据由列名和值组成,提供按照列名取值的接口
QueryInfo
OceanBase提供查询功能,查询的参数使用QueryInfo对象封装,QueryInfo主要包含以下信息:
字段名
含义
startKey
查询范围的开始rowKey
endKey
查询范围的结束rowKey
Flag
查询的标识位:INCLUSIVE_START (结果包含startKey);INCLUSIVE_END(结果包含endKey);MIN_VALUE(startKey是最小值,即比任何用户数据小);MAX_VALUE(endKey是最大值,即比任何用户数据大)
orderBy
排序字段列表,支持多个排序字段,每个字段包括字段名和排序规则(升序/降序)
columns
查询换回的列名列表
pageSize
分页的单页大小
pageNum