GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::InsertRecordsRequest< T > Struct Template Reference

A set of input parameters for 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 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 360 of file insert_records.h.

Constructor & Destructor Documentation

template<typename T >
gpudb::InsertRecordsRequest< T >::InsertRecordsRequest ( )
inline

Constructs an InsertRecordsRequest object with default parameter values.

Definition at line 367 of file insert_records.h.

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.

Definition at line 467 of file insert_records.h.

Member Data Documentation

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

Definition at line 475 of file insert_records.h.

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

Definition at line 476 of file insert_records.h.

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

Definition at line 474 of file insert_records.h.


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