gpudb::InsertRecordsRequest< T > Struct Template Reference

A set of input parameters for insertRecordsRaw(const RawInsertRecordsRequest&) const. More...

#include <gpudb/protocol/insert_records.h>

Public Member Functions
	InsertRecordsRequest ()
	Constructs an InsertRecordsRequest object with default parameter values. More...
	InsertRecordsRequest (const std::string &tableName_, const std::vector< T > &data_, const std::map< std::string, std::string > &options_)
	Constructs an InsertRecordsRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::vector< T >	data
std::map< std::string, std::string >	options

Detailed Description

template<typename T>
struct gpudb::InsertRecordsRequest< T >

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.

Parameters

<T>	The type of object being processed.

Definition at line 266 of file insert_records.h.

Constructor & Destructor Documentation

InsertRecordsRequest() [1/2]

template<typename T >

gpudb::InsertRecordsRequest< T >::InsertRecordsRequest ( )

inline

Constructs an InsertRecordsRequest object with default parameter values.

Definition at line 273 of file insert_records.h.

InsertRecordsRequest() [2/2]

template<typename T >

gpudb::InsertRecordsRequest< T >::InsertRecordsRequest ( const std::string &  tableName_, const std::vector< T > &  data_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an InsertRecordsRequest object with the specified parameters.

Parameters

[in]	tableName_	Table to which the records are to be added. Must be an existing table.
[in]	data_	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 326 of file insert_records.h.

Member Data Documentation

data

template<typename T >

std::vector<T> gpudb::InsertRecordsRequest< T >::data

Definition at line 334 of file insert_records.h.

options

template<typename T >

std::map<std::string, std::string> gpudb::InsertRecordsRequest< T >::options

Definition at line 335 of file insert_records.h.

tableName

template<typename T >

std::string gpudb::InsertRecordsRequest< T >::tableName

Definition at line 333 of file insert_records.h.

---

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

• gpudb/protocol/insert_records.h