append\_records(table\_name=None, source\_table\_name=None, field\_map=None, options={"{"}{"}"})\[source]

Append (or insert) all records from a source table (specified by input parameter source\_table\_name) to a particular target table (specified by input parameter table\_name). The field map (specified by input parameter field\_map) holds the user specified map of target table column names with their mapped source column names.

Parameters

table\_name (str) –

The table name for the records to be appended, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.

source\_table\_name (str) –

The source table name to get records from, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table name.

field\_map (dict of str to str) –

Contains the mapping of column names from the target table (specified by input parameter table\_name) as the keys, and corresponding column names or expressions (e.g., ‘col\_name+1’) from the source table (specified by input parameter source\_table\_name). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.

options (dict of str to str) –

Optional parameters. Allowed keys are:

offset – A positive integer indicating the number of initial results to skip from input parameter source\_table\_name. Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. The default value is ‘0’.
limit – A positive integer indicating the maximum number of results to be returned from input parameter source\_table\_name. Or END\_OF\_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.
expression – Filter expression to apply to the input parameter source\_table\_name. The default value is ‘’.
order\_by – Comma-separated list of the columns to be sorted by from source table (specified by input parameter source\_table\_name), e.g., ‘timestamp asc, x desc’. The order\_by columns do not have to be present in input parameter field\_map. The default value is ‘’.
error\_handling – Specifies how record errors are handled while appending source table records into the target table. Currently this governs primary-key collision behavior: skip and permissive drop the colliding source records and continue, while abort rejects the batch. Explicit update\_on\_existing\_pk or ignore\_existing\_pk take precedence over this option. Allowed values are:
- permissive – Source records that cannot be appended (e.g. a primary-key collision) are skipped and reported; the rest of the batch is appended.
- skip – Source records that cannot be appended are skipped and reported; the rest of the batch is appended.
- abort – A source record that cannot be appended (e.g. a primary-key collision) raises an error. This is the default.
The default value is ‘abort’.
update\_on\_existing\_pk – Specifies the record collision policy for inserting source table records (specified by input parameter source\_table\_name) into a target table (specified by input parameter table\_name) with a primary key. If set to true, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by ignore\_existing\_pk. If the specified table does not have a primary key, then this option has no effect. Allowed values are:
- true – Upsert new records when primary keys match existing records.
- false – Reject new records when primary keys match existing records.
The default value is ‘false’.
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. Allowed values are:
- true
- false
The default value is ‘true’.
ignore\_existing\_pk – Specifies the record collision error-suppression policy for inserting source table records (specified by input parameter source\_table\_name) into a target table (specified by input parameter table\_name) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If false, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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. Allowed values are:
- true – Ignore source table records whose primary key values collide with those of target table records.
- false – Raise an error for any source table record whose primary key values collide with those of a target table record.
The default value is ‘false’.
pk\_conflict\_predicate\_higher – The record with higher value for the column resolves the primary-key insert conflict. The default value is ‘’.
pk\_conflict\_predicate\_lower – The record with lower value for the column resolves the primary-key insert conflict. The default value is ‘’.
truncate\_strings – If set to true, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Allowed values are:
- true
- false
The default value is ‘false’.

The default value is an empty dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

table\_name (str) –

The name of the table to which the records were appended.

info (dict of str to str) –

Additional information. The default value is an empty dict ( {"{"}{"}"} ).