Skip to main content

​
◆ insertRecordsFromQuery() [1/2]

InsertRecordsFromQueryResponse kinetica.Kinetica.insertRecordsFromQuery (InsertRecordsFromQueryRequestrequest_)
 inline

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 50815 of file KineticaFunctions.cs.

​
◆ insertRecordsFromQuery() [2/2]

InsertRecordsFromQueryResponse kinetica.Kinetica.insertRecordsFromQuery (stringtable_name,
stringremote_query,
IDictionary< string, IDictionary< string, string > >modify_columns = null,
IDictionary< string, string >create_table_options = null,
IDictionary< string, string >options = null )
 inline

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

Parameters
table_nameName 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_queryQuery for which result data needs to be imported.
modify_columnsNot implemented yet. The default value is an empty Dictionary.
create_table_optionsOptions used when creating the target table.The default value is an empty Dictionary.
optionsOptional parameters.
  • 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. Supported values:
    • 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. Supported values:
    • 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. Supported values:
    • 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. Supported values:The default value is FALSE.
  • TRUNCATE_TABLE: If set to TRUE, truncates the table specified by table_name prior to loading the data. Supported values: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. Supported values: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. Supported values: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. Supported values:
    • 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 Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 51537 of file KineticaFunctions.cs.

​
◆ InsertRecordsFromQueryAsync() [1/2]

async System.Threading.Tasks.Task< InsertRecordsFromQueryResponse > kinetica.Kinetica.InsertRecordsFromQueryAsync (InsertRecordsFromQueryRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 50831 of file KineticaFunctions.cs.

​
◆ InsertRecordsFromQueryAsync() [2/2]

async System.Threading.Tasks.Task< InsertRecordsFromQueryResponse > kinetica.Kinetica.InsertRecordsFromQueryAsync (stringtable_name,
stringremote_query,
IDictionary< string, IDictionary< string, string > >modify_columns = null,
IDictionary< string, string >create_table_options = null,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

Parameters
table_nameName 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_queryQuery for which result data needs to be imported.
modify_columnsNot implemented yet. The default value is an empty Dictionary.
create_table_optionsOptions used when creating the target table.The default value is an empty Dictionary.
optionsOptional parameters.
  • 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. Supported values:
    • 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. Supported values:
    • 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. Supported values:
    • 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. Supported values:The default value is FALSE.
  • TRUNCATE_TABLE: If set to TRUE, truncates the table specified by table_name prior to loading the data. Supported values: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. Supported values: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. Supported values: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. Supported values:
    • 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 Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 52250 of file KineticaFunctions.cs.