Version:

Insert Records Request

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
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). The supported values are:

  • true
  • false
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. The supported values are:

  • true
  • false
dry_run

If set to true, no data will be saved and any errors will be returned. The supported values are:

  • true
  • false

Output Parameter Description

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.

Possible Parameters (keys) Parameter Description
bad_record_indices If return_individual_errors option is specified or implied, returns a comma-separated list of invalid indices (0-based)
error_N Error message for record at index N (0-based)