insert\_records\_from\_query(table\_name=None, remote\_query=None, modify\_columns={"{"}{"}"}, create\_table\_options={"{"}{"}"}, options={"{"}{"}"})\[source]

Computes remote query result and inserts the result data into a new or existing table.

Parameters

table\_name (str) –

Name of the table into which the data will be inserted, in \[schema\_name.]table\_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type\_id or the type inferred from the remote query, and the new table name will have to meet standard table naming criteria.

remote\_query (str) –

Query for which result data needs to be imported.

modify\_columns (dict of str to dicts of str to str) –

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

create\_table\_options (dict of str to str) –

Options used when creating the target table. Allowed keys are:

type\_id – ID of a currently registered type. The default value is ‘’.
no\_error\_if\_exists – If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Allowed values are:
- true
- false
The default value is ‘false’.
is\_replicated – Affects the distribution scheme for the table’s data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type\_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Allowed values are:
- true
- false
The default value is ‘false’.
foreign\_keys – Semicolon-separated list of foreign keys, of the format ‘(source\_column\_name \[, …]) references target\_table\_name(primary\_key\_column\_name \[, …]) \[as foreign\_key\_name]’.
foreign\_shard\_key – Foreign shard key of the format ‘source\_column references shard\_by\_column from target\_table(primary\_key\_column)’.
partition\_type – Partitioning scheme to use. Allowed values are:
- RANGE – Use range partitioning.
- INTERVAL – Use interval partitioning.
- LIST – Use list partitioning.
- HASH – Use hash partitioning.
- SERIES – Use series partitioning.
partition\_keys – Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition\_definitions.
partition\_definitions – Comma-separated list of partition definitions, whose format depends on the choice of partition\_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
is\_automatic\_partition – If true, a new partition will be created for values which don’t fall into an existing partition. Currently only supported for list partitions. Allowed values are:
- true
- false
The default value is ‘false’.
ttl – Sets the TTL of the table specified in input parameter table\_name.
chunk\_size – Indicates the number of records per chunk to be used for this table.
is\_result\_table – Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Allowed values are:
- true
- false
The default value is ‘false’.
strategy\_definition – The tier strategy for the table and its columns.
compression\_codec – The default compression codec for this table’s columns.

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

options (dict of str to str) –

Optional parameters. Allowed keys are:

bad\_record\_table\_name – Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string). When error handling is Abort, bad records table is not populated.
bad\_record\_table\_limit – A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
batch\_size – Number of records per batch when inserting data.
datasource\_name – Name of an existing external data source from which table will be loaded.
error\_handling – Specifies how errors should be handled upon insertion. Allowed values are:
- permissive – Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- skip – Malformed records are skipped.
- ignore\_bad\_records – Deprecated. Alias for skip.
- abort – Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
The default value is ‘abort’.
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 ‘’.
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 error\_handling. 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 new records whose primary key values collide with those of existing records.
- false – Treat as errors any new records whose primary key values collide with those of existing records.
The default value is ‘false’.
ingestion\_mode – Whether to do a full load, dry run, or perform a type inference on the source data. Allowed values are:
- full – Run a type inference on the source data (if needed) and ingest.
- dry\_run – Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error\_handling.
- type\_inference\_only – Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
The default value is ‘full’.
jdbc\_fetch\_size – The JDBC fetch size, which determines how many rows to fetch per round trip.
jdbc\_session\_init\_statement – Executes the statement per each JDBC session before doing actual load. The default value is ‘’.
num\_splits\_per\_rank – Number of splits for reading data per rank. Default will be external\_file\_reader\_num\_tasks. The default value is ‘’.
num\_tasks\_per\_rank – Number of tasks for reading data per rank. Default will be external\_file\_reader\_num\_tasks.
primary\_keys – Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ‘’.
shard\_keys – Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ‘’.
subscribe – Continuously poll the data source to check for new data and load it into the table. Allowed values are:
- true
- false
The default value is ‘false’.
truncate\_table – If set to true, truncates the table specified by input parameter table\_name prior to loading the data. Allowed values are:
- true
- false
The default value is ‘false’.
remote\_query – Remote SQL query from which data will be sourced.
remote\_query\_order\_by – Name of column to be used for splitting the query into multiple sub-queries using ordering of given column. The default value is ‘’.
remote\_query\_filter\_column – Name of column to be used for splitting the query into multiple sub-queries using the data distribution of given column. The default value is ‘’.
remote\_query\_increasing\_column – Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP). The default value is ‘’.
remote\_query\_partition\_column – Alias name for remote\_query\_filter\_column. The default value is ‘’.
truncate\_strings – If set to true, truncate string values that are longer than the column’s type size. Allowed values are:
- true
- false
The default value is ‘false’.
enable\_inplace\_updates – Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it 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’.
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 and error\_handling. 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’.

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

Returns

A dict with the following entries–

table\_name (str) –

Value of input parameter table\_name.

type\_id (str) –

ID of the currently registered table structure type for the target table.

type\_definition (str) –

A JSON string describing the columns of the target table.

type\_label (str) –

The user-defined description associated with the target table’s structure.

type\_properties (dict of str to lists of str) –

A mapping of each target table column name to an array of column properties associated with that column.

count\_inserted (long) –

Number of records inserted into the target table.

count\_skipped (long) –

Number of records skipped, when not running in abort error handling mode.

count\_updated (long) –

\[Not yet implemented] Number of records updated within the target table.

info (dict of str to str) –

Additional information.