Skip to main content

A set of string constants for the parameter InsertRecordsFromQueryRequest.options. More…

​
Static Public Attributes

const string BAD_RECORD_TABLE_NAME = “bad_record_table_name”
 Name of a table to which records that were rejected are written.
 
const string BAD_RECORD_TABLE_LIMIT = “bad_record_table_limit”
 A positive integer indicating the maximum number of records that can be written to the bad-record-table.
 
const string BATCH_SIZE = “batch_size”
 Number of records per batch when inserting data.
 
const string DATASOURCE_NAME = “datasource_name”
 Name of an existing external data source from which table will be loaded.
 
const string ERROR_HANDLING = “error_handling”
 Specifies how errors should be handled upon insertion.
 
const string PERMISSIVE = “permissive”
 Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
 
const string IGNORE_BAD_RECORDS = “ignore_bad_records”
 Malformed records are skipped.
 
const string ABORT = “abort”
 Stops current insertion and aborts entire operation when an error is encountered.
 
const string IGNORE_EXISTING_PK = “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).
 
const string TRUE = “true”
 A boolean constant for the InsertRecordsFromQueryRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the InsertRecordsFromQueryRequest.Options options.
 
const string INGESTION_MODE = “ingestion_mode”
 Whether to do a full load, dry run, or perform a type inference on the source data.
 
const string FULL = “full”
 Run a type inference on the source data (if needed) and ingest.
 
const string DRY_RUN = “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.
 
const string TYPE_INFERENCE_ONLY = “type_inference_only”
 Infer the type of the source data and return, without ingesting any data.
 
const string JDBC_FETCH_SIZE = “jdbc_fetch_size”
 The JDBC fetch size, which determines how many rows to fetch per round trip.
 
const string JDBC_SESSION_INIT_STATEMENT = “jdbc_session_init_statement”
 Executes the statement per each JDBC session before doing actual load.
 
const string NUM_SPLITS_PER_RANK = “num_splits_per_rank”
 Number of splits for reading data per rank.
 
const string NUM_TASKS_PER_RANK = “num_tasks_per_rank”
 Number of tasks for reading data per rank.
 
const string PRIMARY_KEYS = “primary_keys”
 Comma separated list of column names, to set as primary keys, when not specified in the type.
 
const string SHARD_KEYS = “shard_keys”
 Comma separated list of column names, to set as shard keys, when not specified in the type.
 
const string SUBSCRIBE = “subscribe”
 Continuously poll the data source to check for new data and load it into the table.
 
const string TRUNCATE_TABLE = “truncate_table”
 If set to TRUE, truncates the table specified by InsertRecordsFromQueryRequest.table_name prior to loading the data.
 
const string REMOTE_QUERY = “remote_query”
 Remote SQL query from which data will be sourced.
 
const string REMOTE_QUERY_ORDER_BY = “remote_query_order_by”
 Name of column to be used for splitting the query into multiple sub-queries using ordering of given column.
 
const string REMOTE_QUERY_FILTER_COLUMN = “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.
 
const string REMOTE_QUERY_INCREASING_COLUMN = “remote_query_increasing_column”
 Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP).
 
const string REMOTE_QUERY_PARTITION_COLUMN = “remote_query_partition_column”
 Alias name for REMOTE_QUERY_FILTER_COLUMN.
 
const string TRUNCATE_STRINGS = “truncate_strings”
 If set to TRUE, truncate string values that are longer than the column’s type size.
 
const string ENABLE_INPLACE_UPDATES = “enable_inplace_updates”
 Applies only when upserting (when update_on_existing_pk is true).
 
const string UPDATE_ON_EXISTING_PK = “update_on_existing_pk”
 Specifies the record collision policy for inserting into a table with a primary key.
 

​
Detailed Description

A set of string constants for the parameter InsertRecordsFromQueryRequest.options.

Optional parameters.

Definition at line 283 of file InsertRecordsFromQuery.cs.

​
Member Data Documentation

​
◆ ABORT

const string kinetica.InsertRecordsFromQueryRequest.Options.ABORT = “abort”
 static

Stops current insertion and aborts entire operation when an error is encountered.

Primary key collisions are considered abortable errors in this mode.

Definition at line 349 of file InsertRecordsFromQuery.cs.

​
◆ BAD_RECORD_TABLE_LIMIT

const string kinetica.InsertRecordsFromQueryRequest.Options.BAD_RECORD_TABLE_LIMIT = “bad_record_table_limit”
 static

A positive integer indicating the maximum number of records that can be written to the bad-record-table.

Default value is 10000.

Definition at line 296 of file InsertRecordsFromQuery.cs.

​
◆ BAD_RECORD_TABLE_NAME

const string kinetica.InsertRecordsFromQueryRequest.Options.BAD_RECORD_TABLE_NAME = “bad_record_table_name”
 static

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.

Definition at line 291 of file InsertRecordsFromQuery.cs.

​
◆ BATCH_SIZE

const string kinetica.InsertRecordsFromQueryRequest.Options.BATCH_SIZE = “batch_size”
 static

Number of records per batch when inserting data.

Definition at line 299 of file InsertRecordsFromQuery.cs.

​
◆ DATASOURCE_NAME

const string kinetica.InsertRecordsFromQueryRequest.Options.DATASOURCE_NAME = “datasource_name”
 static

Name of an existing external data source from which table will be loaded.

Definition at line 303 of file InsertRecordsFromQuery.cs.

​
◆ DRY_RUN

const string kinetica.InsertRecordsFromQueryRequest.Options.DRY_RUN = “dry_run”
 static

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.

Definition at line 451 of file InsertRecordsFromQuery.cs.

​
◆ ENABLE_INPLACE_UPDATES

const string kinetica.InsertRecordsFromQueryRequest.Options.ENABLE_INPLACE_UPDATES = “enable_inplace_updates”
 static

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.

Definition at line 603 of file InsertRecordsFromQuery.cs.

​
◆ ERROR_HANDLING

const string kinetica.InsertRecordsFromQueryRequest.Options.ERROR_HANDLING = “error_handling”
 static

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.
  • IGNORE_BAD_RECORDS: Malformed records are skipped.
  • 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.

Definition at line 336 of file InsertRecordsFromQuery.cs.

​
◆ FALSE

const string kinetica.InsertRecordsFromQueryRequest.Options.FALSE = “false”
 static

A boolean constant for the InsertRecordsFromQueryRequest.Options options.

Definition at line 405 of file InsertRecordsFromQuery.cs.

​
◆ FULL

const string kinetica.InsertRecordsFromQueryRequest.Options.FULL = “full”
 static

Run a type inference on the source data (if needed) and ingest.

Definition at line 444 of file InsertRecordsFromQuery.cs.

​
◆ IGNORE_BAD_RECORDS

const string kinetica.InsertRecordsFromQueryRequest.Options.IGNORE_BAD_RECORDS = “ignore_bad_records”
 static

Malformed records are skipped.

Definition at line 343 of file InsertRecordsFromQuery.cs.

​
◆ IGNORE_EXISTING_PK

const string kinetica.InsertRecordsFromQueryRequest.Options.IGNORE_EXISTING_PK = “ignore_existing_pk”
 static

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.

Definition at line 397 of file InsertRecordsFromQuery.cs.

​
◆ INGESTION_MODE

const string kinetica.InsertRecordsFromQueryRequest.Options.INGESTION_MODE = “ingestion_mode”
 static

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.

Definition at line 440 of file InsertRecordsFromQuery.cs.

​
◆ JDBC_FETCH_SIZE

const string kinetica.InsertRecordsFromQueryRequest.Options.JDBC_FETCH_SIZE = “jdbc_fetch_size”
 static

The JDBC fetch size, which determines how many rows to fetch per round trip.

Definition at line 461 of file InsertRecordsFromQuery.cs.

​
◆ JDBC_SESSION_INIT_STATEMENT

const string kinetica.InsertRecordsFromQueryRequest.Options.JDBC_SESSION_INIT_STATEMENT = “jdbc_session_init_statement”
 static

Executes the statement per each JDBC session before doing actual load.

The default value is ”.

Definition at line 466 of file InsertRecordsFromQuery.cs.

​
◆ NUM_SPLITS_PER_RANK

const string kinetica.InsertRecordsFromQueryRequest.Options.NUM_SPLITS_PER_RANK = “num_splits_per_rank”
 static

Number of splits for reading data per rank.

Default will be external_file_reader_num_tasks. The default value is ”.

Definition at line 471 of file InsertRecordsFromQuery.cs.

​
◆ NUM_TASKS_PER_RANK

const string kinetica.InsertRecordsFromQueryRequest.Options.NUM_TASKS_PER_RANK = “num_tasks_per_rank”
 static

Number of tasks for reading data per rank.

Default will be external_file_reader_num_tasks.

Definition at line 476 of file InsertRecordsFromQuery.cs.

​
◆ PERMISSIVE

const string kinetica.InsertRecordsFromQueryRequest.Options.PERMISSIVE = “permissive”
 static

Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.

Definition at line 340 of file InsertRecordsFromQuery.cs.

​
◆ PRIMARY_KEYS

const string kinetica.InsertRecordsFromQueryRequest.Options.PRIMARY_KEYS = “primary_keys”
 static

Comma separated list of column names, to set as primary keys, when not specified in the type.

The default value is ”.

Definition at line 481 of file InsertRecordsFromQuery.cs.

​
◆ REMOTE_QUERY

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY = “remote_query”
 static

Remote SQL query from which data will be sourced.

Definition at line 533 of file InsertRecordsFromQuery.cs.

​
◆ REMOTE_QUERY_FILTER_COLUMN

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY_FILTER_COLUMN = “remote_query_filter_column”
 static

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 ”.

Definition at line 544 of file InsertRecordsFromQuery.cs.

​
◆ REMOTE_QUERY_INCREASING_COLUMN

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY_INCREASING_COLUMN = “remote_query_increasing_column”
 static

Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP).

The default value is ”.

Definition at line 549 of file InsertRecordsFromQuery.cs.

​
◆ REMOTE_QUERY_ORDER_BY

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY_ORDER_BY = “remote_query_order_by”
 static

Name of column to be used for splitting the query into multiple sub-queries using ordering of given column.

The default value is ”.

Definition at line 538 of file InsertRecordsFromQuery.cs.

​
◆ REMOTE_QUERY_PARTITION_COLUMN

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY_PARTITION_COLUMN = “remote_query_partition_column”
 static

Alias name for REMOTE_QUERY_FILTER_COLUMN.

The default value is ”.

Definition at line 555 of file InsertRecordsFromQuery.cs.

​
◆ SHARD_KEYS

const string kinetica.InsertRecordsFromQueryRequest.Options.SHARD_KEYS = “shard_keys”
 static

Comma separated list of column names, to set as shard keys, when not specified in the type.

The default value is ”.

Definition at line 486 of file InsertRecordsFromQuery.cs.

​
◆ SUBSCRIBE

const string kinetica.InsertRecordsFromQueryRequest.Options.SUBSCRIBE = “subscribe”
 static

Continuously poll the data source to check for new data and load it into the table.

Supported values:

The default value is FALSE.

Definition at line 506 of file InsertRecordsFromQuery.cs.

​
◆ TRUE

const string kinetica.InsertRecordsFromQueryRequest.Options.TRUE = “true”
 static

A boolean constant for the InsertRecordsFromQueryRequest.Options options.

Definition at line 401 of file InsertRecordsFromQuery.cs.

​
◆ TRUNCATE_STRINGS

const string kinetica.InsertRecordsFromQueryRequest.Options.TRUNCATE_STRINGS = “truncate_strings”
 static

If set to TRUE, truncate string values that are longer than the column’s type size.

Supported values:

The default value is FALSE.

Definition at line 577 of file InsertRecordsFromQuery.cs.

​
◆ TRUNCATE_TABLE

const string kinetica.InsertRecordsFromQueryRequest.Options.TRUNCATE_TABLE = “truncate_table”
 static

If set to TRUE, truncates the table specified by InsertRecordsFromQueryRequest.table_name prior to loading the data.

Supported values:

The default value is FALSE.

Definition at line 529 of file InsertRecordsFromQuery.cs.

​
◆ TYPE_INFERENCE_ONLY

const string kinetica.InsertRecordsFromQueryRequest.Options.TYPE_INFERENCE_ONLY = “type_inference_only”
 static

Infer the type of the source data and return, without ingesting any data.

The inferred type is returned in the response.

Definition at line 457 of file InsertRecordsFromQuery.cs.

​
◆ UPDATE_ON_EXISTING_PK

const string kinetica.InsertRecordsFromQueryRequest.Options.UPDATE_ON_EXISTING_PK = “update_on_existing_pk”
 static

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.

Definition at line 642 of file InsertRecordsFromQuery.cs.

The documentation for this struct was generated from the following files: