飞奔的炮台 发表于 2021-12-15 22:21:12

【TcaplusDB知识库】[Generic表]根据部分Key字段值读取数据接口说明

【TcaplusDB知识库】根据部分Key字段值读取数据接口说明

概述
根据部分Key字段值,从指定的表格中读取多条数据。
注意:按部分Key字段值读取数据之前,先要创建以对应键值为Key的索引,否则会报找不到索引的错误。

示例代码
同步调用参见章节:[​​Generic表]根据部分Key字段值读取数据示例代码​​。
异步调用参见章节:​​异步调用接口示例代码​​。

Request对象方法说明
注:如有未列出来的Request对象方法,即表示该方法在根据部分Key字段值读取数据的场景下是无效的。
方法签名
方法说明
​​void setCmd(int cmd)​​
设置请求类型(指令)。cmd:请求类型,固定为TcaplusProtocolCsConstants.TCAPLUS_CMD_GET_BY_PARTKEY_REQ。
​​void setTableName(String tableName)​​
设置目标表名。tableName:目标表名,不能为null。
​​Record addRecord()​​
获取数据对象(Record),用于设置读取的数据的Key,用户可以调用该对象的setKeyXXX方法设置各Key字段的值。
​​void addFieldName(String fieldName)​​
添加需要查询的数据的Value字段的名称。fieldName:Value字段名,不能为null。
​​void setPartkeyGetParam(int offset, int num)​​
设置只返回结果列表中从offset开始的number个数据,不设置即返回所有满足条件的数据。offset:起始位置。num:返回的最大数据个数。

Request中的Record对象方法说明
注:如有未列出来的Record对象方法,即表示该方法在根据部分Key字段值读取数据的场景下是无效的。
方法签名
方法说明
​​void setVersion(int version)​​
设置数据的版本号。version:如果设置为负数,表示当前数据不启动版本控制。
​​void setKeyByte(String fieldName, byte value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的byte类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyShort(String fieldName, short value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的short类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyInt(String fieldName, int value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的int类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyLong(String fieldName, long value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的long类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyFloat(String fieldName, float value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的float类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyDouble(String fieldName, double value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的double类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyString(String fieldName, String value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的String类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。
​​void setKeyBlob(String fieldName, byte[] value)​​
设置指定名称的Key字段的值。注意:当TDR表描述文件中定义的字段类型与Java的byte[]类型对应时,才可调用该方法设置字段值,否则服务端在处理请求时会参数错误。参见​​TDR表字段类型与Java类型对应关系​​。fieldName:字段名称,不可为null。value:字段的新值。

Response对象方法说明
注:如有未列出来的Response对象方法,即表示该方法在根据部分Key字段值读取数据的场景下是无效的。
方法签名
方法说明
​​int getResult()​​
获取根据部分Key字段值读取数据请求的响应码。0表示操作成功。非0表示操作异常,参见​​响应码含义说明​​。
​​List<Record> getRecordList()​​
获取读取返回的数据对象列表。用户可以调用该对象的getValueXXX方法获取各Value字段的值。

Response中的Record对象方法说明
注:如有未列出来的Record对象方法,即表示该方法在根据部分Key字段值读取数据的场景下是无效的。
方法签名
方法说明
方法签名
方法说明
​​int getVersion()​​
获取数据的版本号。
​​int getValueCount()​​
获取数据的Value字段的个数。
​​byte getValueByte(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​short getValueShort(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​int getValueInt(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​long getValueLong(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​float getValueFloat(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​double getValueDouble(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​String getValueString(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​byte[] getValueBlob(String fieldName)​​
获取指定名称的Value字段的值。fieldName:字段名称,不可为null。
​​
TcaplusDB是腾讯出品的分布式NoSQL数据库,存储和调度的代码完全自研。具备缓存+落地融合架构、PB级存储、毫秒级时延、无损水平扩展和复杂数据结构等特性。同时具备丰富的生态、便捷的迁移、极低的运维成本和五个九高可用等特点。客户覆盖游戏、互联网、政务、金融、制造和物联网等领域。


https://blog.51cto.com/u_15137725/4804798
页: [1]
查看完整版本: 【TcaplusDB知识库】[Generic表]根据部分Key字段值读取数据接口说明