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

Public Attributes
const string	BAD_RECORD_TABLE_NAME = "bad_record_table_name"
	Optional name of a table to which records that were rejected are written. More...

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

const string	BATCH_SIZE = "batch_size"
	Number of records per batch when inserting data. More...

const string	DATASOURCE_NAME = "datasource_name"
	Name of an existing external data source from which table will be loaded More...

const string	ERROR_HANDLING = "error_handling"
	Specifies how errors should be handled upon insertion. More...

const string	PERMISSIVE = "permissive"
	Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped. More...

const string	IGNORE_BAD_RECORDS = "ignore_bad_records"
	Malformed records are skipped. More...

const string	ABORT = "abort"
	Stops current insertion and aborts entire operation when an error is encountered. More...

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). More...

const string	TRUE = "true"
	Upsert new records when primary keys match existing records More...

const string	FALSE = "false"
	Reject new records when primary keys match existing records More...

const string	INGESTION_MODE = "ingestion_mode"
	Whether to do a full load, dry run, or perform a type inference on the source data. More...

const string	FULL = "full"
	Run a type inference on the source data (if needed) and ingest More...

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

const string	TYPE_INFERENCE_ONLY = "type_inference_only"
	Infer the type of the source data and return, without ingesting any data. More...

const string	JDBC_FETCH_SIZE = "jdbc_fetch_size"
	The JDBC fetch size, which determines how many rows to fetch per round trip. More...

const string	JDBC_SESSION_INIT_STATEMENT = "jdbc_session_init_statement"
	Executes the statement per each jdbc session before doing actual load. More...

const string	NUM_SPLITS_PER_RANK = "num_splits_per_rank"
	Optional: number of splits for reading data per rank. More...

const string	NUM_TASKS_PER_RANK = "num_tasks_per_rank"
	Optional: number of tasks for reading data per rank. More...

const string	PRIMARY_KEYS = "primary_keys"
	Optional: comma separated list of column names, to set as primary keys, when not specified in the type. More...

const string	SHARD_KEYS = "shard_keys"
	Optional: comma separated list of column names, to set as primary keys, when not specified in the type. More...

const string	SUBSCRIBE = "subscribe"
	Continuously poll the data source to check for new data and load it into the table. More...

const string	TRUNCATE_TABLE = "truncate_table"
	If set to TRUE, truncates the table specified by table_name prior to loading the data. More...

const string	REMOTE_QUERY = "remote_query"
	Remote SQL query from which data will be sourced More...

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

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

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). More...

const string	REMOTE_QUERY_PARTITION_COLUMN = "remote_query_partition_column"
	Alias name for remote_query_filter_column. More...

const string	TRUNCATE_STRINGS = "truncate_strings"
	If set to TRUE, truncate string values that are longer than the column's type size. More...

const string	UPDATE_ON_EXISTING_PK = "update_on_existing_pk"
	Specifies the record collision policy for inserting into a table with a primary key. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 236 of file InsertRecordsFromQuery.cs.

Member Data Documentation

◆ ABORT

const string kinetica.InsertRecordsFromQueryRequest.Options.ABORT = "abort"

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 301 of file InsertRecordsFromQuery.cs.

◆ BAD_RECORD_TABLE_LIMIT

const string kinetica.InsertRecordsFromQueryRequest.Options.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.

Default value is 10000

Definition at line 249 of file InsertRecordsFromQuery.cs.

◆ BAD_RECORD_TABLE_NAME

const string kinetica.InsertRecordsFromQueryRequest.Options.BAD_RECORD_TABLE_NAME = "bad_record_table_name"

Optional 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 244 of file InsertRecordsFromQuery.cs.

◆ BATCH_SIZE

const string kinetica.InsertRecordsFromQueryRequest.Options.BATCH_SIZE = "batch_size"

Number of records per batch when inserting data.

Definition at line 253 of file InsertRecordsFromQuery.cs.

◆ DATASOURCE_NAME

const string kinetica.InsertRecordsFromQueryRequest.Options.DATASOURCE_NAME = "datasource_name"

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

Definition at line 257 of file InsertRecordsFromQuery.cs.

◆ DRY_RUN

const string kinetica.InsertRecordsFromQueryRequest.Options.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.

Definition at line 375 of file InsertRecordsFromQuery.cs.

◆ ERROR_HANDLING

const string kinetica.InsertRecordsFromQueryRequest.Options.ERROR_HANDLING = "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.
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 287 of file InsertRecordsFromQuery.cs.

◆ FALSE

const string kinetica.InsertRecordsFromQueryRequest.Options.FALSE = "false"

Reject new records when primary keys match existing records

Definition at line 335 of file InsertRecordsFromQuery.cs.

◆ FULL

const string kinetica.InsertRecordsFromQueryRequest.Options.FULL = "full"

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

Definition at line 369 of file InsertRecordsFromQuery.cs.

◆ IGNORE_BAD_RECORDS

const string kinetica.InsertRecordsFromQueryRequest.Options.IGNORE_BAD_RECORDS = "ignore_bad_records"

Malformed records are skipped.

Definition at line 295 of file InsertRecordsFromQuery.cs.

◆ IGNORE_EXISTING_PK

const string kinetica.InsertRecordsFromQueryRequest.Options.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).

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 327 of file InsertRecordsFromQuery.cs.

◆ INGESTION_MODE

const string kinetica.InsertRecordsFromQueryRequest.Options.INGESTION_MODE = "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.

Definition at line 365 of file InsertRecordsFromQuery.cs.

◆ JDBC_FETCH_SIZE

const string kinetica.InsertRecordsFromQueryRequest.Options.JDBC_FETCH_SIZE = "jdbc_fetch_size"

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

Definition at line 385 of file InsertRecordsFromQuery.cs.

◆ JDBC_SESSION_INIT_STATEMENT

const string kinetica.InsertRecordsFromQueryRequest.Options.JDBC_SESSION_INIT_STATEMENT = "jdbc_session_init_statement"

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

The default value is ''.

Definition at line 390 of file InsertRecordsFromQuery.cs.

◆ NUM_SPLITS_PER_RANK

const string kinetica.InsertRecordsFromQueryRequest.Options.NUM_SPLITS_PER_RANK = "num_splits_per_rank"

Optional: number of splits for reading data per rank.

Default will be external_file_reader_num_tasks. The default value is ''.

Definition at line 396 of file InsertRecordsFromQuery.cs.

◆ NUM_TASKS_PER_RANK

const string kinetica.InsertRecordsFromQueryRequest.Options.NUM_TASKS_PER_RANK = "num_tasks_per_rank"

Optional: number of tasks for reading data per rank.

Default will be external_file_reader_num_tasks

Definition at line 402 of file InsertRecordsFromQuery.cs.

◆ PERMISSIVE

const string kinetica.InsertRecordsFromQueryRequest.Options.PERMISSIVE = "permissive"

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

Definition at line 292 of file InsertRecordsFromQuery.cs.

◆ PRIMARY_KEYS

const string kinetica.InsertRecordsFromQueryRequest.Options.PRIMARY_KEYS = "primary_keys"

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

The default value is ''.

Definition at line 407 of file InsertRecordsFromQuery.cs.

◆ REMOTE_QUERY

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY = "remote_query"

Remote SQL query from which data will be sourced

Definition at line 447 of file InsertRecordsFromQuery.cs.

◆ REMOTE_QUERY_FILTER_COLUMN

const string kinetica.InsertRecordsFromQueryRequest.Options.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.

The default value is ''.

Definition at line 458 of file InsertRecordsFromQuery.cs.

◆ REMOTE_QUERY_INCREASING_COLUMN

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY_INCREASING_COLUMN = "remote_query_increasing_column"

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

The default value is ''.

Definition at line 463 of file InsertRecordsFromQuery.cs.

◆ REMOTE_QUERY_ORDER_BY

const string kinetica.InsertRecordsFromQueryRequest.Options.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.

The default value is ''.

Definition at line 452 of file InsertRecordsFromQuery.cs.

◆ REMOTE_QUERY_PARTITION_COLUMN

const string kinetica.InsertRecordsFromQueryRequest.Options.REMOTE_QUERY_PARTITION_COLUMN = "remote_query_partition_column"

Alias name for remote_query_filter_column.

The default value is ''.

Definition at line 467 of file InsertRecordsFromQuery.cs.

◆ SHARD_KEYS

const string kinetica.InsertRecordsFromQueryRequest.Options.SHARD_KEYS = "shard_keys"

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

The default value is ''.

Definition at line 412 of file InsertRecordsFromQuery.cs.

◆ SUBSCRIBE

const string kinetica.InsertRecordsFromQueryRequest.Options.SUBSCRIBE = "subscribe"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 427 of file InsertRecordsFromQuery.cs.

◆ TRUE

const string kinetica.InsertRecordsFromQueryRequest.Options.TRUE = "true"

Upsert new records when primary keys match existing records

Definition at line 331 of file InsertRecordsFromQuery.cs.

◆ TRUNCATE_STRINGS

const string kinetica.InsertRecordsFromQueryRequest.Options.TRUNCATE_STRINGS = "truncate_strings"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 483 of file InsertRecordsFromQuery.cs.

◆ TRUNCATE_TABLE

const string kinetica.InsertRecordsFromQueryRequest.Options.TRUNCATE_TABLE = "truncate_table"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 443 of file InsertRecordsFromQuery.cs.

◆ TYPE_INFERENCE_ONLY

const string kinetica.InsertRecordsFromQueryRequest.Options.TYPE_INFERENCE_ONLY = "type_inference_only"

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

The inferred type is returned in the response.

Definition at line 381 of file InsertRecordsFromQuery.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.InsertRecordsFromQueryRequest.Options.UPDATE_ON_EXISTING_PK = "update_on_existing_pk"

Specifies the record collision policy for inserting into a table with a primary key.

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 504 of file InsertRecordsFromQuery.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/InsertRecordsFromQuery.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ABORT

◆ BAD_RECORD_TABLE_LIMIT

◆ BAD_RECORD_TABLE_NAME

◆ BATCH_SIZE

◆ DATASOURCE_NAME

◆ DRY_RUN

◆ ERROR_HANDLING

◆ FALSE

◆ FULL

◆ IGNORE_BAD_RECORDS

◆ IGNORE_EXISTING_PK

◆ INGESTION_MODE

◆ JDBC_FETCH_SIZE

◆ JDBC_SESSION_INIT_STATEMENT

◆ NUM_SPLITS_PER_RANK

◆ NUM_TASKS_PER_RANK

◆ PERMISSIVE

◆ PRIMARY_KEYS

◆ REMOTE_QUERY

◆ REMOTE_QUERY_FILTER_COLUMN

◆ REMOTE_QUERY_INCREASING_COLUMN

◆ REMOTE_QUERY_ORDER_BY

◆ REMOTE_QUERY_PARTITION_COLUMN

◆ SHARD_KEYS

◆ SUBSCRIBE

◆ TRUE

◆ TRUNCATE_STRINGS

◆ TRUNCATE_TABLE

◆ TYPE_INFERENCE_ONLY

◆ UPDATE_ON_EXISTING_PK