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.

	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.

	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.

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.

std::vector\< std::vector\< uint8\_t > >	list
	An array of binary-encoded data for the records to be added.

std::vector\< std::string >	listStr
	An array of JSON encoded data for the records to be added.

std::string	listEncoding
	The encoding of the records to be inserted.

std::map\< std::string, std::string >	options
	Optional parameters.

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, and 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\_enable\_inplace\_updates: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true, an existing record matched by primary key is modified in place. If set to false, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values: insert\_records\_true insert\_records\_false The default value is insert\_records\_true. 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 and 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\_pk\_conflict\_predicate\_higher: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''. insert\_records\_pk\_conflict\_predicate\_lower: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''. 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). 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. insert\_records\_request\_schema\_str: Type schema of list\_ (when listEncoding\_ is binary), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''. insert\_records\_transformations: Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''. The default value is an empty map.

Definition at line 331 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, and 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\_enable\_inplace\_updates: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true, an existing record matched by primary key is modified in place. If set to false, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values: insert\_records\_true insert\_records\_false The default value is insert\_records\_true. 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 and 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\_pk\_conflict\_predicate\_higher: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''. insert\_records\_pk\_conflict\_predicate\_lower: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''. 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). 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. insert\_records\_request\_schema\_str: Type schema of list\_ (when listEncoding\_ is binary), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''. insert\_records\_transformations: Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''. The default value is an empty map.

Definition at line 639 of file insert\_records.h.

Member Data Documentation

◆ list

std::vector\ > 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 661 of file insert\_records.h.

◆ listEncoding

std::string gpudb::RawInsertRecordsRequest::listEncoding

The encoding of the records to be inserted.

Supported values:

The default value is insert\_records\_binary.

Definition at line 680 of file insert\_records.h.

◆ listStr

std::vector\ 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 668 of file insert\_records.h.

◆ options

std::map\ 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, and 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\_enable\_inplace\_updates: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true, an existing record matched by primary key is modified in place. If set to false, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
- insert\_records\_true
- insert\_records\_false
The default value is insert\_records\_true.
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 and 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\_pk\_conflict\_predicate\_higher: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
insert\_records\_pk\_conflict\_predicate\_lower: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
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). 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.
insert\_records\_request\_schema\_str: Type schema of list (when listEncoding is binary), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
insert\_records\_transformations: Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''.

The default value is an empty map.

Definition at line 876 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 654 of file insert\_records.h.

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

gpudb/protocol/insert\_records.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RawInsertRecordsRequest() \[1/3]

◆ RawInsertRecordsRequest() \[2/3]

◆ RawInsertRecordsRequest() \[3/3]

Member Data Documentation

◆ list

◆ listEncoding

◆ listStr

◆ options

◆ tableName