gpudb::RawInsertRecordsRequest Struct Reference

A set of input parameters for insertRecordsRaw(const RawInsertRecordsRequest&) 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 insertRecordsRaw(const RawInsertRecordsRequest&) 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

RawInsertRecordsRequest() [1/3]

gpudb::RawInsertRecordsRequest::RawInsertRecordsRequest ( )

inline

Constructs a RawInsertRecordsRequest object with default parameter values.

Definition at line 40 of file insert_records.h.

RawInsertRecordsRequest() [2/3]

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. gpudb::insert_records_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_return_record_ids: If true then return the internal record id along for each inserted record. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false.

Definition at line 95 of file insert_records.h.

RawInsertRecordsRequest() [3/3]

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. gpudb::insert_records_binary gpudb::insert_records_json The default value is gpudb::insert_records_binary.
[in]	options_	Optional parameters. gpudb::insert_records_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_return_record_ids: If true then return the internal record id along for each inserted record. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false.

Definition at line 162 of file insert_records.h.

Member Data Documentation

list

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

Definition at line 172 of file insert_records.h.

listEncoding

std::string gpudb::RawInsertRecordsRequest::listEncoding

Definition at line 174 of file insert_records.h.

listStr

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

Definition at line 173 of file insert_records.h.

options

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

Definition at line 175 of file insert_records.h.

tableName

std::string gpudb::RawInsertRecordsRequest::tableName

Definition at line 171 of file insert_records.h.

---

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

• gpudb/protocol/insert_records.h