OceanBase客户端使用指南.docx

OceanBase客户端使用指南1OceanBase客户端工作原理32客户端常用数据结构说明32.1rowkey32.2RowData32.3QueryInfo32.4InsertMutator和UpdateMutator43接口使用说明43.1初始化OceanBase java客户端43.1.1配置项43.1.2创建客户端实例43.2接口使用说明53.2.1ResultCode定义53.2.2get53.2.3query53.2.4insert63.2.5update63.2.6delete6本文档描述OceanBase客户端的使用方法，由于当前仅提供Java客户端，所以暂时只包含Java客户端的使用方法。文档主要包括以下几个部分：客户端的工作原理客户端常用数据结构说明客户端的初始化和接口使用说明OceanBase客户端工作原理OceanBase是一个分布式表格存储系统，主要包括以下模块：rootserverupdateserverchunkservermergeserverrootserver负责维护系统数据的分布信息，客户端根据用户请求的rowkey，从rootserver查询负责该rowkey对应数据的mergeserver。updateserver负责整个系统的数据更新，更新的数据会定期合并到chunkserver。chunkserver负责静态数据的存储。mergeserver提供系统的查询服务，当接收到查询时，mergeserver会根据相应的rowkey（或者范围）请求chunkserver上存储的静态数据，以及updateserver上更新的数据，然后做合并，返回结果数据。mergeserver还支持对数据的过滤，排序等操作。客户端常用数据结构说明rowkeyOceanBase中所有的数据都需要有一个rowkey，数据在存储时按照rowkey排序。RowKey为字节流，rowkey的结构在系统的schema中指定。RowDataOceanBase客户端使用RowData来表示一行数据，该数据结构通常用在查询返回时。数据结构包括：表名rowkey各列数据，列的数据由列名和值组成，提供按照列名取值的接口QueryInfoOceanBase提供查询功能，查询的参数使用QueryInfo对象封装，QueryInfo主要包含以下信息：字段名含义startKey查询范围的开始rowKeyendKey查询范围的结束rowKeyFlag查询的标识位：INCLUSIVE_START （结果包含startKey）；INCLUSIVE_END（结果包含endKey）；MIN_VALUE（startKey是最小值，即比任何用户数据小）；MAX_VALUE（endKey是最大值，即比任何用户数据大）orderBy排序字段列表，支持多个排序字段，每个字段包括字段名和排序规则（升序/降序）columns查询换回的列名列表pageSize分页的单页大小pageNum分页时当前的页码Limit单次查询返回的最大条目数filter过滤条件，比如price 1.0等groupbyParamgroupBy的条件参数InsertMutator和UpdateMutatorMutator封装了对一条记录的修改操作，客户端把要修改的数据填充在Mutator中，作为请求参数发送到updateserver，updateserver执行相应的操作。Mutator的主要数据结构包括：字段名含义Table更新的表名rowKey待更新的数据的rowKeyColumns待更新的数据列表，结构为ListTuple，其中Tupe为一个name/value对接口使用说明初始化OceanBase java客户端配置项OceanBase客户端支持3个配置项名称类型默认值含义IPString无Rootserver的地址PortInt无Rootserver的端口TimeoutInt1000客户端请求的超时时间，单位为毫秒（ms）创建客户端实例Client obclient = null;// 创建一个客户端实例ClientImpl clientInstance = new ClientImpl();clientInstance.setIp(192.168.0.1); // 设置rootserver地址clientInstance.setPort(1234); // 设置rootserver端口clientInstance.setTimeout(2000); // 设置超时时间obclient = clientInstance;接口使用说明OceanBase的客户端只要提供读取、查询和更新的接口。ResultCode定义OceanBase客户端使用返回值来标识请求的结果，可能的返回值