gpudb::RawInsertRecordsRequest Struct Reference

A set of parameters for GPUdb::insertRecordsRaw. More...

#include <gpudb/protocol/insert_records.h>

Public Member Functions
	RawInsertRecordsRequest ()
	Constructs a RawInsertRecordsRequest object with default parameters. 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
	Name of table to which the records are to be added, in [ schema_name. ]table_name format, using standard name resolution rules. More...
std::vector< std::vector< uint8_t > >	list
	An array of binary-encoded data for the records to be added. More...
std::vector< std::string >	listStr
	An array of JSON encoded data for the records to be added. More...
std::string	listEncoding
	The encoding of the records to be inserted. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::insertRecordsRaw.

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 35 of file insert_records.h.

Constructor & Destructor Documentation

RawInsertRecordsRequest() [1/3]

gpudb::RawInsertRecordsRequest::RawInsertRecordsRequest ( )

inline

Constructs a RawInsertRecordsRequest object with default parameters.

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_	Name of table to which the records are to be added, in [schema_name.]table_name format, using standard name resolution rules. 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. 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 (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values: insert_records_true: Upsert new records when primary keys match existing records insert_records_false: Reject new records when primary keys match existing records The default value is insert_records_false. insert_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by allow_partial_batch & return_individual_errors. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values: insert_records_true: Ignore new records whose primary key values collide with those of existing records insert_records_false: Treat as errors any new records whose primary key values collide with those of existing records The default value is insert_records_false. insert_records_return_record_ids: If true then return the internal record id along for each inserted record. Supported values: insert_records_true insert_records_false The default value is insert_records_false. 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. Supported values: insert_records_true insert_records_false The default value is insert_records_false. 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). Supported values: insert_records_true insert_records_false The default value is insert_records_false. 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. Supported values: insert_records_true insert_records_false The default value is insert_records_false. insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. Supported values: insert_records_true insert_records_false The default value is insert_records_false. The default value is an empty map.

Definition at line 260 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_	Name of table to which the records are to be added, in [schema_name.]table_name format, using standard name resolution rules. 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. Supported values: insert_records_binary insert_records_json The default value is insert_records_binary.
[in]	options_	Optional parameters. 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 (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values: insert_records_true: Upsert new records when primary keys match existing records insert_records_false: Reject new records when primary keys match existing records The default value is insert_records_false. insert_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by allow_partial_batch & return_individual_errors. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values: insert_records_true: Ignore new records whose primary key values collide with those of existing records insert_records_false: Treat as errors any new records whose primary key values collide with those of existing records The default value is insert_records_false. insert_records_return_record_ids: If true then return the internal record id along for each inserted record. Supported values: insert_records_true insert_records_false The default value is insert_records_false. 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. Supported values: insert_records_true insert_records_false The default value is insert_records_false. 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). Supported values: insert_records_true insert_records_false The default value is insert_records_false. 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. Supported values: insert_records_true insert_records_false The default value is insert_records_false. insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. Supported values: insert_records_true insert_records_false The default value is insert_records_false. The default value is an empty map.

Definition at line 497 of file insert_records.h.

Member Data Documentation

list

std::vector<std::vector<uint8_t> > gpudb::RawInsertRecordsRequest::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.

Definition at line 519 of file insert_records.h.

listEncoding

std::string gpudb::RawInsertRecordsRequest::listEncoding

The encoding of the records to be inserted.

Supported values:

• insert_records_binary
• insert_records_json

The default value is insert_records_binary.

Definition at line 538 of file insert_records.h.

listStr

std::vector<std::string> gpudb::RawInsertRecordsRequest::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.

Definition at line 526 of file insert_records.h.

options

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

Optional parameters.

• 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 (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values:
  • insert_records_true: Upsert new records when primary keys match existing records
  • insert_records_false: Reject new records when primary keys match existing records
  The default value is insert_records_false.
• insert_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by allow_partial_batch & return_individual_errors. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
  • insert_records_true: Ignore new records whose primary key values collide with those of existing records
  • insert_records_false: Treat as errors any new records whose primary key values collide with those of existing records
  The default value is insert_records_false.
• insert_records_return_record_ids: If true then return the internal record id along for each inserted record. Supported values:
  • insert_records_true
  • insert_records_false
  The default value is insert_records_false.
• 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. Supported values:
  • insert_records_true
  • insert_records_false
  The default value is insert_records_false.
• 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). Supported values:
  • insert_records_true
  • insert_records_false
  The default value is insert_records_false.
• 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. Supported values:
  • insert_records_true
  • insert_records_false
  The default value is insert_records_false.
• insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. Supported values:
  • insert_records_true
  • insert_records_false
  The default value is insert_records_false.

The default value is an empty map.

Definition at line 685 of file insert_records.h.

tableName

std::string gpudb::RawInsertRecordsRequest::tableName

Name of table to which the records are to be added, in [ schema_name. ]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 512 of file insert_records.h.

---

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

• gpudb/protocol/insert_records.h