[tcapulusdb knowledge base] [generic table] read data interface description

【TcaplusDB The knowledge base 】[Generic surface ] Read the data interface description

summary

Reads the specified table from the specified table Key A single piece of data .

Sample code

See Chapter... For synchronous call ：[Generic surface ] Read data sample code .

See Chapter... For asynchronous call ： Asynchronous call interface sample code .

Request Object method description

notes ： If not listed Request Object methods , This means that this method is invalid in the scenario of reading data .

Method signature	Method statement
void setCmd(int cmd)	Set request type （ Instructions ）.cmd： Request type , Fixed for TcaplusProtocolCsConstants.TCAPLUS_CMD_GET_REQ.
void setTableName(String tableName)	Set the target table name .tableName： Target table name , Not for null.
Record addRecord()	Get data objects （Record）, Used to set the value of the read data Key, The user can call the... Of the object setKeyXXX Method to set each Key Value of field .
void addFieldName(String fieldName)	Add the data to be queried Value Name of field .fieldName：Value Field name , Not for null.

Request Medium Record Object method description

notes ： If not listed Record Object methods , This means that this method is invalid in the scenario of reading data .

Method signature	Method statement
void setVersion(int version)	Set the version number of the data .version： If it is set to a negative number , Indicates that the current data does not start version control .
void setKeyByte(String fieldName, byte value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of byte When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyShort(String fieldName, short value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of short When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyInt(String fieldName, int value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of int When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyLong(String fieldName, long value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of long When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyFloat(String fieldName, float value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of float When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyDouble(String fieldName, double value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of double When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyString(String fieldName, String value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of String When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .
void setKeyBlob(String fieldName, byte[] value)	Sets the of the specified name Key Value of field . Be careful ： When TDR The table describes the field types and defined in the file Java Of byte[] When type corresponds , This method can be called to set the field value , Otherwise, the server will have parameter errors when processing the request . See TDR Table field type and Java Type correspondence .fieldName： Field name , Do not for null.value： New value for field .

Response Object method description

notes ： If not listed Response Object methods , This means that this method is invalid in the scenario of querying data .

Method signature	Method statement
int getResult()	Get the response code of the read data request .0 Indicates the operation is successful . Not 0 Indicates that the operation is abnormal , See the meaning of response code .
Record fetchRecord()	Get the data object returned from reading . The user can call the... Of the object getValueXXX Method to get each Value Value of field .

Response Medium Record Object method description

notes ： If not listed Record Object methods , This means that this method is invalid in the scenario of reading data .

Method signature	Method statement
int getVersion()	Get the version number of the data .
int getValueCount()	Access to data Value Number of fields .
byte getValueByte(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
short getValueShort(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
int getValueInt(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
long getValueLong(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
float getValueFloat(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
double getValueDouble(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
String getValueString(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.
byte[] getValueBlob(String fieldName)	Gets the... Of the specified name Value Value of field .fieldName： Field name , Do not for null.

---

TcaplusDB It's a distributed product of Tencent NoSQL database , The code for storage and scheduling is completely self-developed . With cache + Landing fusion architecture 、PB Levels of storage 、 Millisecond delay 、 Lossless horizontal expansion and complex data structure . At the same time, it has rich ecological environment 、 Easy migration 、 Extremely low operation and maintenance costs and five nine high availability features . Customer coverage game 、 Internet 、 government affairs 、 Finance 、 Manufacturing and the Internet of things .