GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::RawInsertRecordsRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/insert_records.h>

Public Member Functions

 RawInsertRecordsRequest ()
 Constructs a RawInsertRecordsRequest object with default parameter values. More...
 
 RawInsertRecordsRequest (const std::string &tableName_, const std::vector< std::vector< uint8_t > > &list_, const std::map< std::string, std::string > &options_)
 Constructs a RawInsertRecordsRequest object with the specified parameters. More...
 
 RawInsertRecordsRequest (const std::string &tableName_, const std::vector< std::vector< uint8_t > > &list_, const std::vector< std::string > &listStr_, const std::string &listEncoding_, const std::map< std::string, std::string > &options_)
 Constructs a RawInsertRecordsRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::vector< std::vector
< uint8_t > > 
list
 
std::vector< std::string > listStr
 
std::string listEncoding
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Definition at line 33 of file insert_records.h.

Constructor & Destructor Documentation

gpudb::RawInsertRecordsRequest::RawInsertRecordsRequest ( )
inline

Constructs a RawInsertRecordsRequest object with default parameter values.

Definition at line 40 of file insert_records.h.

gpudb::RawInsertRecordsRequest::RawInsertRecordsRequest ( const std::string &  tableName_,
const std::vector< std::vector< uint8_t > > &  list_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters
[in]tableName_Table to which the records are to be added. Must be an existing table.
[in]list_An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.
[in]options_Optional parameters.

Definition at line 142 of file insert_records.h.

gpudb::RawInsertRecordsRequest::RawInsertRecordsRequest ( const std::string &  tableName_,
const std::vector< std::vector< uint8_t > > &  list_,
const std::vector< std::string > &  listStr_,
const std::string &  listEncoding_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters
[in]tableName_Table to which the records are to be added. Must be an existing table.
[in]list_An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.
[in]listStr_An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is binary.
[in]listEncoding_The encoding of the records to be inserted. The default value is gpudb::insert_records_binary.
[in]options_Optional parameters.

Definition at line 256 of file insert_records.h.

Member Data Documentation

std::vector<std::vector<uint8_t> > gpudb::RawInsertRecordsRequest::list

Definition at line 266 of file insert_records.h.

std::string gpudb::RawInsertRecordsRequest::listEncoding

Definition at line 268 of file insert_records.h.

std::vector<std::string> gpudb::RawInsertRecordsRequest::listStr

Definition at line 267 of file insert_records.h.

std::map<std::string, std::string> gpudb::RawInsertRecordsRequest::options

Definition at line 269 of file insert_records.h.

std::string gpudb::RawInsertRecordsRequest::tableName

Definition at line 265 of file insert_records.h.


The documentation for this struct was generated from the following file: