GPUdb C++ API  Version 5.2.0.0
gpudb::InsertRecordsResponse Struct Reference

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

#include <gpudb/protocol/insert_records.h>

Public Member Functions

 InsertRecordsResponse ()
 Constructs an InsertRecordsResponse object with default parameter values. More...
 

Public Attributes

std::vector< std::string > recordIds
 
int32_t countInserted
 
int32_t countUpdated
 

Detailed Description

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

Adds multiple records to the specified table. The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored.

Definition at line 349 of file insert_records.h.

Constructor & Destructor Documentation

gpudb::InsertRecordsResponse::InsertRecordsResponse ( )
inline

Constructs an InsertRecordsResponse object with default parameter values.

Definition at line 356 of file insert_records.h.

Member Data Documentation

int32_t gpudb::InsertRecordsResponse::countInserted

Definition at line 364 of file insert_records.h.

int32_t gpudb::InsertRecordsResponse::countUpdated

Definition at line 365 of file insert_records.h.

std::vector<std::string> gpudb::InsertRecordsResponse::recordIds

Definition at line 363 of file insert_records.h.


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