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. 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. gpudb::insert_records_truncate_strings: If set to true, any strings which are too long for their target charN string columns will be truncated to fit. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_return_individual_errors: If set to true, success will always be returned, and any errors found will be included in the info map. The "bad_record_indices" entry is a comma-separated list of bad records (0-based). And if so, there will also be an "error_N" entry for each record with an error, where N is the index (0-based). gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_allow_partial_batch: If set to true, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false.

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. 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. gpudb::insert_records_truncate_strings: If set to true, any strings which are too long for their target charN string columns will be truncated to fit. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_return_individual_errors: If set to true, success will always be returned, and any errors found will be included in the info map. The "bad_record_indices" entry is a comma-separated list of bad records (0-based). And if so, there will also be an "error_N" entry for each record with an error, where N is the index (0-based). gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_allow_partial_batch: If set to true, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false. gpudb::insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. gpudb::insert_records_true gpudb::insert_records_false The default value is gpudb::insert_records_false.

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:

• gpudb/protocol/insert_records.h