【TcaplusDB知识库】[List表]读取列表所有数据接口说明
概述
从指定的表格中读取指定Key的列表的所有数据。
示例代码
同步调用参见章节：[List表]读取列表所有数据示例代码。
异步调用参见章节：异步调用接口示例代码。
Request对象方法说明
注：如有未列出来的Request对象方法，即表示该方法在读取数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
void setCmd(int cmd) |
设置请求类型（指令）。cmd：请求类型，固定为TcaplusProtocolCsConstants.TCAPLUS_CMD_LIST_GETALL_REQ。 |
void setTableName(String tableName) |
设置目标表名。tableName：目标表名，不能为null。 |
Record addRecord() |
获取数据对象（Record），用于设置读取的数据的Key，用户可以调用该对象的setKeyXXX方法设置各Key字段的值。 |
void addFieldName(String fieldName) |
添加需要查询的数据的Value字段的名称。fieldName：Value字段名，不能为null。 |
Request中的Record对象方法说明
注：如有未列出来的Record对象方法，即表示该方法在读取数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
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对象方法，即表示该方法在查询数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
int getResult() |
获取读取数据请求的响应码。0表示操作成功。非0表示操作异常，参见响应码含义说明。 |
Record fetchRecord() |
获取读取返回的数据对象。用户可以循环调用该方法，逐条获取返回的数据，当该方法返回null时，表示所有数据读取完毕。用户可以调用该对象的getValueXXX方法获取各Value字段的值。 |
Response中的Record对象方法说明
注：如有未列出来的Record对象方法，即表示该方法在读取数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
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级存储、毫秒级时延、无损水平扩展和复杂数据结构等特性。同时具备丰富的生态、便捷的迁移、极低的运维成本和五个九高可用等特点。客户覆盖游戏、互联网、政务、金融、制造和物联网等领域。