Version:

/insert/records

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/insert/records

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 input parameter 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.

Input Parameter Description

Name Type Description
table_name string Table to which the records are to be added. Must be an existing table.
list array of bytes 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 input parameter list_encoding is json.
list_str array of strings 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 input parameter list_encoding is binary.
list_encoding string

The encoding of the records to be inserted. The supported values are:

  • binary
  • json
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
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. The supported values are:

  • true
  • false
return_record_ids

If true then return the internal record id along for each inserted record. The supported values are:

  • true
  • false
truncate_strings

If set to true, any strings which are too long for their target charN string columns will be truncated to fit. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'insert_records_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /insert/records endpoint:

Name Type Description
record_ids array of strings An array containing the IDs with which the added records are identified internally.
count_inserted int The number of records inserted.
count_updated int The number of records updated.
info map of string to strings Additional information.

Empty string in case of an error.