kinetica.CreateTableExternalRequest.Options

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

Static Public Attributes
const string	AVRO_SCHEMA = “avro_schema”
	String representing the Avro schema, for data that includes only records (i.e.

const string	AVRO_SCHEMA_NO_INFERENCE = “avro_schema_no_inference”
	Create table solely from the Avro schema definition, when AVRO_SCHEMA exists; do not infer from data.

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	BAD_RECORD_TABLE_LIMIT_PER_INPUT = “bad_record_table_limit_per_input”
	For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload.

const string	BAD_RECORD_TABLE_NAME = “bad_record_table_name”
	Name of a table to which records that were rejected are written.

const string	BATCH_SIZE = “batch_size”
	Number of records to insert per batch when inserting data.

const string	COLUMN_FORMATS = “column_formats”
	For each target column specified, applies the column-property-bound format to the source data loaded into that column.

const string	COLUMNS_TO_LOAD = “columns_to_load”
	Specifies a comma-delimited list of source-data columns that supply the target table’s columns.

const string	COLUMNS_TO_SKIP = “columns_to_skip”
	Specifies a comma-delimited list of source-data columns to exclude from the load.

const string	COMPRESSION_TYPE = “compression_type”
	Source data compression type.

const string	NONE = “none”
	No compression.

const string	AUTO = “auto”
	Auto detect compression type.

const string	GZIP = “gzip”
	gzip file compression.

const string	BZIP2 = “bzip2”
	bzip2 file compression.

const string	DATALAKE_CATALOG = “datalake_catalog”
	Name of an existing datalake(iceberg) catalog used in loading files.

const string	DATALAKE_PATH = “datalake_path”
	Path of datalake(iceberg) object.

const string	DATALAKE_SNAPSHOT = “datalake_snapshot”
	Snapshot ID of datalake(iceberg) object.

const string	DATASOURCE_NAME = “datasource_name”
	Name of an existing external data source from which data file(s) specified in CreateTableExternalRequest.filepaths will be loaded.

const string	DEFAULT_COLUMN_FORMATS = “default_column_formats”
	Specifies the default format to be applied to source data loaded into columns with the corresponding column property.

const string	ENABLE_INPLACE_UPDATES = “enable_inplace_updates”
	Applies only when upserting (when update_on_existing_pk is true).

const string	TRUE = “true”
	A boolean constant for the CreateTableExternalRequest.Options options.

const string	FALSE = “false”
	A boolean constant for the CreateTableExternalRequest.Options options.

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	SKIP = “skip”
	Malformed records are skipped.

const string	IGNORE_BAD_RECORDS = “ignore_bad_records”
	Deprecated.

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

const string	EXTERNAL_TABLE_TYPE = “external_table_type”
	Specifies whether the external table holds a local copy of the external data.

const string	MATERIALIZED = “materialized”
	Loads a copy of the external data into the database, refreshed on demand.

const string	LOGICAL = “logical”
	External data will not be loaded into the database; the data will be retrieved from the source upon servicing each query against the external table.

const string	FILE_TYPE = “file_type”
	Specifies the type of the file(s) whose records will be inserted.

const string	AVRO = “avro”
	Avro file format.

const string	DELIMITED_TEXT = “delimited_text”
	Delimited text file format; e.g., CSV, TSV, PSV, etc.

const string	GDB = “gdb”
	Esri/GDB file format.

const string	JSON = “json”
	JSON file format.

const string	PARQUET = “parquet”
	Apache Parquet file format.

const string	SHAPEFILE = “shapefile”
	ShapeFile file format.

const string	FLATTEN_COLUMNS = “flatten_columns”
	Specifies how to handle nested columns.

const string	GDAL_CONFIGURATION_OPTIONS = “gdal_configuration_options”
	Comma separated list of gdal conf options, for the specific requests: key=value.

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	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	KAFKA_CONSUMERS_PER_RANK = “kafka_consumers_per_rank”
	Number of Kafka consumer threads per rank (valid range 1-6).

const string	KAFKA_GROUP_ID = “kafka_group_id”
	The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).

const string	KAFKA_OFFSET_RESET_POLICY = “kafka_offset_reset_policy”
	Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset.

const string	EARLIEST = “earliest”
	A constant for the CreateTableExternalRequest.Options options.

const string	LATEST = “latest”
	A constant for the CreateTableExternalRequest.Options options.

const string	KAFKA_OPTIMISTIC_INGEST = “kafka_optimistic_ingest”
	Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism.

const string	KAFKA_SUBSCRIPTION_CANCEL_AFTER = “kafka_subscription_cancel_after”
	Sets the Kafka subscription lifespan (in minutes).

const string	KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT = “kafka_type_inference_fetch_timeout”
	Maximum time to collect Kafka messages before type inferencing on the set of them.

const string	LAYER = “layer”
	Geo files layer(s) name(s): comma separated.

const string	LOADING_MODE = “loading_mode”
	Scheme for distributing the extraction and loading of data from the source data file(s).

const string	HEAD = “head”
	The head node loads all data.

const string	DISTRIBUTED_SHARED = “distributed_shared”
	The head node coordinates loading data by worker processes across all nodes from shared files available to all workers.

const string	DISTRIBUTED_LOCAL = “distributed_local”
	A single worker process on each node loads all files that are available to it.

const string	LOCAL_TIME_OFFSET = “local_time_offset”
	Apply an offset to Avro local timestamp columns.

const string	MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE = “max_consecutive_invalid_schema_failure”
	Max records to skip due to schema related errors, before failing.

const string	MAX_RECORDS_TO_LOAD = “max_records_to_load”
	Limit the number of records to load in this request: if this number is larger than BATCH_SIZE, then the number of records loaded will be limited to the next whole number of BATCH_SIZE (per working thread).

const string	NAME_COLUMNS_FROM_FILE = “name_columns_from_file”
	Specifies a comma-delimited list of column names to be used as the source-data column names.

const string	NUM_TASKS_PER_RANK = “num_tasks_per_rank”
	Number of tasks for reading file per rank.

const string	PK_CONFLICT_PREDICATE_HIGHER = “pk_conflict_predicate_higher”
	The record with higher value for the column resolves the primary-key insert conflict.

const string	PK_CONFLICT_PREDICATE_LOWER = “pk_conflict_predicate_lower”
	The record with lower value for the column resolves the primary-key insert conflict.

const string	POLL_INTERVAL = “poll_interval”
	If TRUE, the number of seconds between attempts to load external files into the table.

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	REFRESH_METHOD = “refresh_method”
	Method by which the table can be refreshed from its source data.

const string	MANUAL = “manual”
	Refresh only occurs when manually requested by invoking the refresh action of Kinetica.alterTable on this table.

const string	ON_START = “on_start”
	Refresh table on database startup and when manually requested by invoking the refresh action of Kinetica.alterTable on this table.

const string	REMOTE_QUERY = “remote_query”
	Remote SQL query from which data will be sourced.

const string	REMOTE_QUERY_FILTER_COLUMN = “remote_query_filter_column”
	Name of column to be used for splitting REMOTE_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	SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries”
	Confluent Schema registry connection timeout (in secs).

const string	SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout”
	Confluent Schema registry connection timeout (in secs).

const string	SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES = “schema_registry_max_consecutive_connection_failures”
	Max records to skip due to SR connection failures, before failing.

const string	SCHEMA_REGISTRY_SCHEMA_NAME = “schema_registry_schema_name”
	Name of the Avro schema in the schema registry to use when reading Avro records.

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	SKIP_LINES = “skip_lines”
	Skip a number of lines from the beginning of the file.

const string	START_OFFSETS = “start_offsets”
	Starting offsets by partition to fetch from kafka.

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

const string	TABLE_INSERT_MODE = “table_insert_mode”
	Insertion scheme to use when inserting records from multiple shapefiles.

const string	SINGLE = “single”
	Insert all records into a single table.

const string	TABLE_PER_FILE = “table_per_file”
	Insert records from each file into a new table corresponding to that file.

const string	TEXT_COMMENT_STRING = “text_comment_string”
	Specifies the character string that should be interpreted as a comment line prefix in the source data.

const string	TEXT_DELIMITER = “text_delimiter”
	Specifies the character delimiting field values in the source data and field names in the header (if present).

const string	TEXT_ESCAPE_CHARACTER = “text_escape_character”
	Specifies the character that is used to escape other characters in the source data.

const string	TEXT_HAS_HEADER = “text_has_header”
	Indicates whether the source data contains a header row.

const string	TEXT_HEADER_PROPERTY_DELIMITER = “text_header_property_delimiter”
	Specifies the delimiter for column properties in the header row (if present).

const string	TEXT_NULL_STRING = “text_null_string”
	Specifies the character string that should be interpreted as a null value in the source data.

const string	TEXT_QUOTE_CHARACTER = “text_quote_character”
	Specifies the character that should be interpreted as a field value quoting character in the source data.

const string	TEXT_SEARCH_COLUMNS = “text_search_columns”
	Add ‘text_search’ property to internally inferenced string columns.

const string	TEXT_SEARCH_MIN_COLUMN_LENGTH = “text_search_min_column_length”
	Set the minimum column size for strings to apply the ‘text_search’ property to.

const string	TRANSFORMATIONS = “transformations”
	Comma-separated expressions, one per target table column.

const string	TRIM_SPACE = “trim_space”
	If set to TRUE, remove leading or trailing space from fields.

const string	TRUNCATE_STRINGS = “truncate_strings”
	If set to TRUE, truncate string values that are longer than the column’s type size.

const string	TRUNCATE_TABLE = “truncate_table”
	If set to TRUE, truncates the table specified by CreateTableExternalRequest.table_name prior to loading the file(s).

const string	TYPE_INFERENCE_MAX_RECORDS_READ = “type_inference_max_records_read”
	A constant for the CreateTableExternalRequest.Options options.

const string	TYPE_INFERENCE_MODE = “type_inference_mode”
	Optimize type inferencing for either speed or accuracy.

const string	ACCURACY = “accuracy”
	Scans data to get exactly-typed and sized columns for all data scanned.

const string	SPEED = “speed”
	Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned.

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 CreateTableExternalRequest.options.

Optional parameters.

Definition at line 302 of file CreateTableExternal.cs.

Member Data Documentation

◆ ABORT

const string kinetica.CreateTableExternalRequest.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 633 of file CreateTableExternal.cs.

◆ ACCURACY

const string kinetica.CreateTableExternalRequest.Options.ACCURACY = “accuracy”

static

Scans data to get exactly-typed and sized columns for all data scanned.

Definition at line 1461 of file CreateTableExternal.cs.

◆ AUTO

const string kinetica.CreateTableExternalRequest.Options.AUTO = “auto”

static

Auto detect compression type.

Definition at line 487 of file CreateTableExternal.cs.

◆ AVRO

const string kinetica.CreateTableExternalRequest.Options.AVRO = “avro”

static

Avro file format.

Definition at line 718 of file CreateTableExternal.cs.

◆ AVRO_SCHEMA

const string kinetica.CreateTableExternalRequest.Options.AVRO_SCHEMA = “avro_schema”

static

String representing the Avro schema, for data that includes only records (i.e.

does not embed its own schema).

Definition at line 307 of file CreateTableExternal.cs.

◆ AVRO_SCHEMA_NO_INFERENCE

const string kinetica.CreateTableExternalRequest.Options.AVRO_SCHEMA_NO_INFERENCE = “avro_schema_no_inference”

static

Create table solely from the Avro schema definition, when AVRO_SCHEMA exists; do not infer from data.

Definition at line 313 of file CreateTableExternal.cs.

◆ BAD_RECORD_TABLE_LIMIT

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

The default value is ‘10000’.

Definition at line 318 of file CreateTableExternal.cs.

◆ BAD_RECORD_TABLE_LIMIT_PER_INPUT

const string kinetica.CreateTableExternalRequest.Options.BAD_RECORD_TABLE_LIMIT_PER_INPUT = “bad_record_table_limit_per_input”

static

For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload.

Default value will be BAD_RECORD_TABLE_LIMIT and total size of the table per rank is limited to BAD_RECORD_TABLE_LIMIT.

Definition at line 328 of file CreateTableExternal.cs.

◆ BAD_RECORD_TABLE_NAME

const string kinetica.CreateTableExternalRequest.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 339 of file CreateTableExternal.cs.

◆ BATCH_SIZE

const string kinetica.CreateTableExternalRequest.Options.BATCH_SIZE = “batch_size”

static

Number of records to insert per batch when inserting data.

The default value is ‘50000’.

Definition at line 344 of file CreateTableExternal.cs.

◆ BZIP2

const string kinetica.CreateTableExternalRequest.Options.BZIP2 = “bzip2”

static

bzip2 file compression.

Definition at line 493 of file CreateTableExternal.cs.

◆ COLUMN_FORMATS

const string kinetica.CreateTableExternalRequest.Options.COLUMN_FORMATS = “column_formats”

static

For each target column specified, applies the column-property-bound format to the source data loaded into that column.

Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, and datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., ’ “order_date” : “date” : “%Y.%m.%d” , “order_time” : “time” : “%H:%M:%S” ’.

See DEFAULT_COLUMN_FORMATS for valid format syntax.

Definition at line 360 of file CreateTableExternal.cs.

◆ COLUMNS_TO_LOAD

const string kinetica.CreateTableExternalRequest.Options.COLUMNS_TO_LOAD = “columns_to_load”

static

Specifies a comma-delimited list of source-data columns that supply the target table’s columns.

If more than one file is being loaded, this list applies to all files.

Mutually exclusive with COLUMNS_TO_SKIP.

This list is a positional mapping onto the target table rather than a filter: the i-th entry identifies the source column that feeds the i-th column of the target table.

Entries may be column numbers, column names, or empty.

Column numbers are 1-based, specified discretely or as a range. For example, ‘5,7,,1..3’ inserts the fifth source column into the first target column, the seventh into the second, null into the third, and the first through third into the fourth through sixth. A range may descend (‘3..1’) to reverse that group’s order. Zero is not a valid column number. Numbers are supported only for delimited-text and Avro sources.

Column names are strings, matching the source-data field names – either the file’s header names or the names supplied by NAME_COLUMNS_FROM_FILE. Requires that the source data have column names. Names are matched case-sensitively, and a name not present in the source will fail.

An empty entry, acting as a placeholder meaning that no source column feeds the corresponding target column.

Numbers and names cannot be mixed: a single non-numeric entry causes the entire list to be interpreted as names.

If the external table has no column definition, it is created with these columns in this order, and the list may name any subset of the source columns.

If the external table has a column definition, the number of entries must equal the table’s column count. Use empty entries to pad the list to the table’s width. Because the mapping is positional, this option can also reorder source columns into the table’s column order – for example ‘C, B, A’ for an external table whose columns are C, B, A.

Note: specifying COLUMNS_TO_LOAD disables server-side population of target columns that no source column feeds. Such columns receive NULL instead of their default value, ‘init_with_now’, or ‘init_with_uuid’ value; if the column is non-nullable, the record is rejected. To have unfed target columns take their defaults, omit COLUMNS_TO_LOAD and rely on name-based matching, optionally with COLUMNS_TO_SKIP.

Definition at line 410 of file CreateTableExternal.cs.

◆ COLUMNS_TO_SKIP

const string kinetica.CreateTableExternalRequest.Options.COLUMNS_TO_SKIP = “columns_to_skip”

static

Specifies a comma-delimited list of source-data columns to exclude from the load.

If more than one file is being loaded, this list applies to all files.

Mutually exclusive with COLUMNS_TO_LOAD.

Entries may be column names matching the source-data field names (the file’s header names, or the names supplied by NAME_COLUMNS_FROM_FILE, matched case-sensitively), or 1-based column numbers. Numbers are supported only for delimited-text sources. Name-based entries require the source data to have column names.

If the external table has no column definition, the non-excluded source columns define the external table’s columns, in source-data order.

If the external table has a column definition, the non-excluded source columns are matched to its columns by name, case-insensitively — unlike COLUMNS_TO_LOAD, this option does not change how that matching is done. The order and number of source columns therefore need not correspond to the external table’s columns, and source columns matching none of them need not be listed; they are ignored.

Excluding a source column that corresponds to a target table column causes that target column to be populated from its default value, ‘init_with_*’ property, or null. This makes COLUMNS_TO_SKIP the means of preferring a target column’s default over a value present in the source data.

If the external table has a column definition and the source data has no column names (no header row and no NAME_COLUMNS_FROM_FILE), the non-excluded source columns are matched to its columns by position rather than by name; the source column count must then equal the external table’s column count plus the number of columns skipped.

Definition at line 448 of file CreateTableExternal.cs.

◆ COMPRESSION_TYPE

const string kinetica.CreateTableExternalRequest.Options.COMPRESSION_TYPE = “compression_type”

static

Source data compression type.

Supported values:

NONE: No compression.
AUTO: Auto detect compression type.
GZIP: gzip file compression.
BZIP2: bzip2 file compression.

The default value is AUTO.

Definition at line 481 of file CreateTableExternal.cs.

◆ DATALAKE_CATALOG

const string kinetica.CreateTableExternalRequest.Options.DATALAKE_CATALOG = “datalake_catalog”

static

Name of an existing datalake(iceberg) catalog used in loading files.

Definition at line 497 of file CreateTableExternal.cs.

◆ DATALAKE_PATH

const string kinetica.CreateTableExternalRequest.Options.DATALAKE_PATH = “datalake_path”

static

Path of datalake(iceberg) object.

Definition at line 500 of file CreateTableExternal.cs.

◆ DATALAKE_SNAPSHOT

const string kinetica.CreateTableExternalRequest.Options.DATALAKE_SNAPSHOT = “datalake_snapshot”

static

Snapshot ID of datalake(iceberg) object.

Definition at line 503 of file CreateTableExternal.cs.

◆ DATASOURCE_NAME

const string kinetica.CreateTableExternalRequest.Options.DATASOURCE_NAME = “datasource_name”

static

Name of an existing external data source from which data file(s) specified in CreateTableExternalRequest.filepaths will be loaded.

Definition at line 509 of file CreateTableExternal.cs.

◆ DEFAULT_COLUMN_FORMATS

const string kinetica.CreateTableExternalRequest.Options.DEFAULT_COLUMN_FORMATS = “default_column_formats”

static

Specifies the default format to be applied to source data loaded into columns with the corresponding column property.

Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and format for a given target column in COLUMN_FORMATS. For each specified annotation, the format will apply to all columns with that annotation unless a custom COLUMN_FORMATS for that annotation is specified.

The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., ’ “date” : “%Y.%m.%d”, “time” : “%H:%M:%S” ’. Column formats are specified as a string of control characters and plain text. The supported control characters are ‘Y’, ‘m’, ‘d’, ‘H’, ‘M’, ‘S’, and ‘s’, which follow the Linux ‘strptime()’ specification, as well as ‘s’, which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds).

Formats for the ‘date’ annotation must include the ‘Y’, ‘m’, and ‘d’ control characters. Formats for the ‘time’ annotation must include the ‘H’, ‘M’, and either ‘S’ or ‘s’ (but not both) control characters. Formats for the ‘datetime’ annotation meet both the ‘date’ and ‘time’ control character requirements. For example, ‘“datetime” : “%m/%d/%Y %H:%M:%S” ’ would be used to interpret text as “05/04/2000 12:12:11”.

Definition at line 539 of file CreateTableExternal.cs.

◆ DELIMITED_TEXT

const string kinetica.CreateTableExternalRequest.Options.DELIMITED_TEXT = “delimited_text”

static

Delimited text file format; e.g., CSV, TSV, PSV, etc.

Definition at line 722 of file CreateTableExternal.cs.

◆ DISTRIBUTED_LOCAL

const string kinetica.CreateTableExternalRequest.Options.DISTRIBUTED_LOCAL = “distributed_local”

static

A single worker process on each node loads all files that are available to it.

This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data).

NOTE:

If the target table doesn’t exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail.

If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.

Definition at line 1025 of file CreateTableExternal.cs.

◆ DISTRIBUTED_SHARED

const string kinetica.CreateTableExternalRequest.Options.DISTRIBUTED_SHARED = “distributed_shared”

static

The head node coordinates loading data by worker processes across all nodes from shared files available to all workers.

NOTE:

Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.

Definition at line 1006 of file CreateTableExternal.cs.

◆ DRY_RUN

const string kinetica.CreateTableExternalRequest.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 854 of file CreateTableExternal.cs.

◆ EARLIEST

const string kinetica.CreateTableExternalRequest.Options.EARLIEST = “earliest”

static

A constant for the CreateTableExternalRequest.Options options.

Definition at line 898 of file CreateTableExternal.cs.

◆ ENABLE_INPLACE_UPDATES

const string kinetica.CreateTableExternalRequest.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:

TRUE
FALSE

The default value is TRUE.

Definition at line 565 of file CreateTableExternal.cs.

◆ ERROR_HANDLING

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

Definition at line 614 of file CreateTableExternal.cs.

◆ EXTERNAL_TABLE_TYPE

const string kinetica.CreateTableExternalRequest.Options.EXTERNAL_TABLE_TYPE = “external_table_type”

static

Specifies whether the external table holds a local copy of the external data.

Supported values:

MATERIALIZED: Loads a copy of the external data into the database, refreshed on demand.
LOGICAL: External data will not be loaded into the database; the data will be retrieved from the source upon servicing each query against the external table.

The default value is MATERIALIZED.

Definition at line 659 of file CreateTableExternal.cs.

◆ FALSE

const string kinetica.CreateTableExternalRequest.Options.FALSE = “false”

static

A boolean constant for the CreateTableExternalRequest.Options options.

Definition at line 573 of file CreateTableExternal.cs.

◆ FILE_TYPE

const string kinetica.CreateTableExternalRequest.Options.FILE_TYPE = “file_type”

static

Specifies the type of the file(s) whose records will be inserted.

Supported values:

AVRO: Avro file format.
DELIMITED_TEXT: Delimited text file format; e.g., CSV, TSV, PSV, etc.
GDB: Esri/GDB file format.
JSON: JSON file format.
PARQUET: Apache Parquet file format.
SHAPEFILE: ShapeFile file format.

The default value is DELIMITED_TEXT.

Definition at line 715 of file CreateTableExternal.cs.

◆ FLATTEN_COLUMNS

const string kinetica.CreateTableExternalRequest.Options.FLATTEN_COLUMNS = “flatten_columns”

static

Specifies how to handle nested columns.

Supported values:

TRUE: Break up nested columns to multiple columns.
FALSE: Treat nested columns as JSON columns instead of flattening.

The default value is FALSE.

Definition at line 757 of file CreateTableExternal.cs.

◆ FULL

const string kinetica.CreateTableExternalRequest.Options.FULL = “full”

static

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

Definition at line 847 of file CreateTableExternal.cs.

◆ GDAL_CONFIGURATION_OPTIONS

const string kinetica.CreateTableExternalRequest.Options.GDAL_CONFIGURATION_OPTIONS = “gdal_configuration_options”

static

Comma separated list of gdal conf options, for the specific requests: key=value.

Definition at line 761 of file CreateTableExternal.cs.

◆ GDB

const string kinetica.CreateTableExternalRequest.Options.GDB = “gdb”

static

Esri/GDB file format.

Definition at line 725 of file CreateTableExternal.cs.

◆ GZIP

const string kinetica.CreateTableExternalRequest.Options.GZIP = “gzip”

static

gzip file compression.

Definition at line 490 of file CreateTableExternal.cs.

◆ HEAD

const string kinetica.CreateTableExternalRequest.Options.HEAD = “head”

static

The head node loads all data.

All files must be available to the head node.

Definition at line 996 of file CreateTableExternal.cs.

◆ IGNORE_BAD_RECORDS

const string kinetica.CreateTableExternalRequest.Options.IGNORE_BAD_RECORDS = “ignore_bad_records”

static

Deprecated.

Alias for SKIP.

Definition at line 627 of file CreateTableExternal.cs.

◆ IGNORE_EXISTING_PK

const string kinetica.CreateTableExternalRequest.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 808 of file CreateTableExternal.cs.

◆ INGESTION_MODE

const string kinetica.CreateTableExternalRequest.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 843 of file CreateTableExternal.cs.

◆ JDBC_FETCH_SIZE

const string kinetica.CreateTableExternalRequest.Options.JDBC_FETCH_SIZE = “jdbc_fetch_size”

static

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

The default value is ‘50000’.

Definition at line 865 of file CreateTableExternal.cs.

◆ JSON

const string kinetica.CreateTableExternalRequest.Options.JSON = “json”

static

JSON file format.

Definition at line 728 of file CreateTableExternal.cs.

◆ KAFKA_CONSUMERS_PER_RANK

const string kinetica.CreateTableExternalRequest.Options.KAFKA_CONSUMERS_PER_RANK = “kafka_consumers_per_rank”

static

Number of Kafka consumer threads per rank (valid range 1-6).

The default value is ‘1’.

Definition at line 870 of file CreateTableExternal.cs.

◆ KAFKA_GROUP_ID

const string kinetica.CreateTableExternalRequest.Options.KAFKA_GROUP_ID = “kafka_group_id”

static

The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).

Definition at line 874 of file CreateTableExternal.cs.

◆ KAFKA_OFFSET_RESET_POLICY

const string kinetica.CreateTableExternalRequest.Options.KAFKA_OFFSET_RESET_POLICY = “kafka_offset_reset_policy”

static

Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset.

Supported values:

EARLIEST
LATEST

The default value is EARLIEST.

Definition at line 894 of file CreateTableExternal.cs.

◆ KAFKA_OPTIMISTIC_INGEST

const string kinetica.CreateTableExternalRequest.Options.KAFKA_OPTIMISTIC_INGEST = “kafka_optimistic_ingest”

static

Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 923 of file CreateTableExternal.cs.

◆ KAFKA_SUBSCRIPTION_CANCEL_AFTER

const string kinetica.CreateTableExternalRequest.Options.KAFKA_SUBSCRIPTION_CANCEL_AFTER = “kafka_subscription_cancel_after”

static

Sets the Kafka subscription lifespan (in minutes).

Expired subscription will be cancelled automatically.

Definition at line 929 of file CreateTableExternal.cs.

◆ KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT

const string kinetica.CreateTableExternalRequest.Options.KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT = “kafka_type_inference_fetch_timeout”

static

Maximum time to collect Kafka messages before type inferencing on the set of them.

Definition at line 933 of file CreateTableExternal.cs.

◆ LATEST

const string kinetica.CreateTableExternalRequest.Options.LATEST = “latest”

static

A constant for the CreateTableExternalRequest.Options options.

Definition at line 902 of file CreateTableExternal.cs.

◆ LAYER

const string kinetica.CreateTableExternalRequest.Options.LAYER = “layer”

static

Geo files layer(s) name(s): comma separated.

Definition at line 936 of file CreateTableExternal.cs.

◆ LOADING_MODE

const string kinetica.CreateTableExternalRequest.Options.LOADING_MODE = “loading_mode”

static

Scheme for distributing the extraction and loading of data from the source data file(s).

This option applies only when loading files that are local to the database. Supported values:

HEAD: The head node loads all data. All files must be available to the head node.
DISTRIBUTED_SHARED: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
DISTRIBUTED_LOCAL: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn’t exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.

The default value is HEAD.

Definition at line 991 of file CreateTableExternal.cs.

◆ LOCAL_TIME_OFFSET

const string kinetica.CreateTableExternalRequest.Options.LOCAL_TIME_OFFSET = “local_time_offset”

static

Apply an offset to Avro local timestamp columns.

Definition at line 1028 of file CreateTableExternal.cs.

◆ LOGICAL

const string kinetica.CreateTableExternalRequest.Options.LOGICAL = “logical”

static

External data will not be loaded into the database; the data will be retrieved from the source upon servicing each query against the external table.

Definition at line 668 of file CreateTableExternal.cs.

◆ MANUAL

const string kinetica.CreateTableExternalRequest.Options.MANUAL = “manual”

static

Refresh only occurs when manually requested by invoking the refresh action of Kinetica.alterTable on this table.

Definition at line 1130 of file CreateTableExternal.cs.

◆ MATERIALIZED

const string kinetica.CreateTableExternalRequest.Options.MATERIALIZED = “materialized”

static

Loads a copy of the external data into the database, refreshed on demand.

Definition at line 663 of file CreateTableExternal.cs.

◆ MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE

const string kinetica.CreateTableExternalRequest.Options.MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE = “max_consecutive_invalid_schema_failure”

static

Max records to skip due to schema related errors, before failing.

Definition at line 1032 of file CreateTableExternal.cs.

◆ MAX_RECORDS_TO_LOAD

const string kinetica.CreateTableExternalRequest.Options.MAX_RECORDS_TO_LOAD = “max_records_to_load”

static

Limit the number of records to load in this request: if this number is larger than BATCH_SIZE, then the number of records loaded will be limited to the next whole number of BATCH_SIZE (per working thread).

Definition at line 1041 of file CreateTableExternal.cs.

◆ NAME_COLUMNS_FROM_FILE

const string kinetica.CreateTableExternalRequest.Options.NAME_COLUMNS_FROM_FILE = “name_columns_from_file”

static

Specifies a comma-delimited list of column names to be used as the source-data column names.

Supported for delimited-text sources only.

The i-th name in this list applies to the i-th column in the file. If the file has a header row (i.e., TEXT_HAS_HEADER is TRUE), these names override the file’s header names. If the file has no header row, these names become the source-data column names.

Naming the source columns enables name-based matching against the target table’s columns, and permits name-based COLUMNS_TO_LOAD / COLUMNS_TO_SKIP, which otherwise require a header row.

Note: for a source with no header row, supplying this option changes how source columns are matched to target columns – from positional matching to matching by name. Target columns with no matching source column are then populated from their defaults or null rather than being filled positionally.

The list is not validated against the file’s actual column count. If it is shorter, the trailing source columns are left unnamed.

Definition at line 1066 of file CreateTableExternal.cs.

◆ NONE

const string kinetica.CreateTableExternalRequest.Options.NONE = “none”

static

No compression.

Definition at line 484 of file CreateTableExternal.cs.

◆ NUM_TASKS_PER_RANK

const string kinetica.CreateTableExternalRequest.Options.NUM_TASKS_PER_RANK = “num_tasks_per_rank”

static

Number of tasks for reading file per rank.

Default will be system configuration parameter, external_file_reader_num_tasks.

Definition at line 1072 of file CreateTableExternal.cs.

◆ ON_START

const string kinetica.CreateTableExternalRequest.Options.ON_START = “on_start”

static

Refresh table on database startup and when manually requested by invoking the refresh action of Kinetica.alterTable on this table.

Definition at line 1136 of file CreateTableExternal.cs.

◆ PARQUET

const string kinetica.CreateTableExternalRequest.Options.PARQUET = “parquet”

static

Apache Parquet file format.

Definition at line 731 of file CreateTableExternal.cs.

◆ PERMISSIVE

const string kinetica.CreateTableExternalRequest.Options.PERMISSIVE = “permissive”

static

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

Definition at line 618 of file CreateTableExternal.cs.

◆ PK_CONFLICT_PREDICATE_HIGHER

const string kinetica.CreateTableExternalRequest.Options.PK_CONFLICT_PREDICATE_HIGHER = “pk_conflict_predicate_higher”

static

The record with higher value for the column resolves the primary-key insert conflict.

The default value is ”.

Definition at line 1077 of file CreateTableExternal.cs.

◆ PK_CONFLICT_PREDICATE_LOWER

const string kinetica.CreateTableExternalRequest.Options.PK_CONFLICT_PREDICATE_LOWER = “pk_conflict_predicate_lower”

static

The record with lower value for the column resolves the primary-key insert conflict.

The default value is ”.

Definition at line 1082 of file CreateTableExternal.cs.

◆ POLL_INTERVAL

const string kinetica.CreateTableExternalRequest.Options.POLL_INTERVAL = “poll_interval”

static

If TRUE, the number of seconds between attempts to load external files into the table.

If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is ‘0’.

Definition at line 1092 of file CreateTableExternal.cs.

◆ PRIMARY_KEYS

const string kinetica.CreateTableExternalRequest.Options.PRIMARY_KEYS = “primary_keys”

static

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

Definition at line 1096 of file CreateTableExternal.cs.

◆ REFRESH_METHOD

const string kinetica.CreateTableExternalRequest.Options.REFRESH_METHOD = “refresh_method”

static

Method by which the table can be refreshed from its source data.

Supported values:

MANUAL: Refresh only occurs when manually requested by invoking the refresh action of Kinetica.alterTable on this table.
ON_START: Refresh table on database startup and when manually requested by invoking the refresh action of Kinetica.alterTable on this table.

The default value is MANUAL.

Definition at line 1124 of file CreateTableExternal.cs.

◆ REMOTE_QUERY

const string kinetica.CreateTableExternalRequest.Options.REMOTE_QUERY = “remote_query”

static

Remote SQL query from which data will be sourced.

Definition at line 1140 of file CreateTableExternal.cs.

◆ REMOTE_QUERY_FILTER_COLUMN

const string kinetica.CreateTableExternalRequest.Options.REMOTE_QUERY_FILTER_COLUMN = “remote_query_filter_column”

static

Name of column to be used for splitting REMOTE_QUERY into multiple sub-queries using the data distribution of given column.

Definition at line 1146 of file CreateTableExternal.cs.

◆ REMOTE_QUERY_INCREASING_COLUMN

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

Definition at line 1150 of file CreateTableExternal.cs.

◆ REMOTE_QUERY_PARTITION_COLUMN

const string kinetica.CreateTableExternalRequest.Options.REMOTE_QUERY_PARTITION_COLUMN = “remote_query_partition_column”

static

Alias name for REMOTE_QUERY_FILTER_COLUMN.

Definition at line 1155 of file CreateTableExternal.cs.

◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

const string kinetica.CreateTableExternalRequest.Options.SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries”

static

Confluent Schema registry connection timeout (in secs).

Definition at line 1159 of file CreateTableExternal.cs.

◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

const string kinetica.CreateTableExternalRequest.Options.SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout”

static

Confluent Schema registry connection timeout (in secs).

Definition at line 1163 of file CreateTableExternal.cs.

◆ SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES

const string kinetica.CreateTableExternalRequest.Options.SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES = “schema_registry_max_consecutive_connection_failures”

static

Max records to skip due to SR connection failures, before failing.

Definition at line 1167 of file CreateTableExternal.cs.

◆ SCHEMA_REGISTRY_SCHEMA_NAME

const string kinetica.CreateTableExternalRequest.Options.SCHEMA_REGISTRY_SCHEMA_NAME = “schema_registry_schema_name”

static

Name of the Avro schema in the schema registry to use when reading Avro records.

Definition at line 1171 of file CreateTableExternal.cs.

◆ SHAPEFILE

const string kinetica.CreateTableExternalRequest.Options.SHAPEFILE = “shapefile”

static

ShapeFile file format.

Definition at line 734 of file CreateTableExternal.cs.

◆ SHARD_KEYS

const string kinetica.CreateTableExternalRequest.Options.SHARD_KEYS = “shard_keys”

static

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

Definition at line 1175 of file CreateTableExternal.cs.

◆ SINGLE

const string kinetica.CreateTableExternalRequest.Options.SINGLE = “single”

static

Insert all records into a single table.

Definition at line 1232 of file CreateTableExternal.cs.

◆ SKIP

const string kinetica.CreateTableExternalRequest.Options.SKIP = “skip”

static

Malformed records are skipped.

Definition at line 621 of file CreateTableExternal.cs.

◆ SKIP_LINES

const string kinetica.CreateTableExternalRequest.Options.SKIP_LINES = “skip_lines”

static

Skip a number of lines from the beginning of the file.

Definition at line 1179 of file CreateTableExternal.cs.

◆ SPEED

const string kinetica.CreateTableExternalRequest.Options.SPEED = “speed”

static

Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned.

Definition at line 1465 of file CreateTableExternal.cs.

◆ START_OFFSETS

const string kinetica.CreateTableExternalRequest.Options.START_OFFSETS = “start_offsets”

static

Starting offsets by partition to fetch from kafka.

A comma separated list of partition:offset pairs.

Definition at line 1185 of file CreateTableExternal.cs.

const string kinetica.CreateTableExternalRequest.Options.SUBSCRIBE = “subscribe”

static

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 1205 of file CreateTableExternal.cs.

◆ TABLE_INSERT_MODE

const string kinetica.CreateTableExternalRequest.Options.TABLE_INSERT_MODE = “table_insert_mode”

static

Insertion scheme to use when inserting records from multiple shapefiles.

Supported values:

SINGLE: Insert all records into a single table.
TABLE_PER_FILE: Insert records from each file into a new table corresponding to that file.

The default value is SINGLE.

Definition at line 1229 of file CreateTableExternal.cs.

◆ TABLE_PER_FILE

const string kinetica.CreateTableExternalRequest.Options.TABLE_PER_FILE = “table_per_file”

static

Insert records from each file into a new table corresponding to that file.

Definition at line 1236 of file CreateTableExternal.cs.

◆ TEXT_COMMENT_STRING

const string kinetica.CreateTableExternalRequest.Options.TEXT_COMMENT_STRING = “text_comment_string”

static

Specifies the character string that should be interpreted as a comment line prefix in the source data.

All lines in the data starting with the provided string are ignored.

For DELIMITED_TEXT FILE_TYPE only. The default value is ’#’.

Definition at line 1247 of file CreateTableExternal.cs.

◆ TEXT_DELIMITER

const string kinetica.CreateTableExternalRequest.Options.TEXT_DELIMITER = “text_delimiter”

static

Specifies the character delimiting field values in the source data and field names in the header (if present).

For DELIMITED_TEXT FILE_TYPE only. The default value is ’,’.

Definition at line 1256 of file CreateTableExternal.cs.

◆ TEXT_ESCAPE_CHARACTER

const string kinetica.CreateTableExternalRequest.Options.TEXT_ESCAPE_CHARACTER = “text_escape_character”

static

Specifies the character that is used to escape other characters in the source data.

An ‘a’, ‘b’, ‘f’, ‘n’, ‘r’, ‘t’, or ‘v’ preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, and vertical tab, respectively. For example, the escape character followed by an ‘n’ will be interpreted as a newline within a field value.

The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not.

For DELIMITED_TEXT FILE_TYPE only.

Definition at line 1274 of file CreateTableExternal.cs.

◆ TEXT_HAS_HEADER

const string kinetica.CreateTableExternalRequest.Options.TEXT_HAS_HEADER = “text_has_header”

static

Indicates whether the source data contains a header row.

For DELIMITED_TEXT FILE_TYPE only. Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 1299 of file CreateTableExternal.cs.

◆ TEXT_HEADER_PROPERTY_DELIMITER

const string kinetica.CreateTableExternalRequest.Options.TEXT_HEADER_PROPERTY_DELIMITER = “text_header_property_delimiter”

static

Specifies the delimiter for column properties in the header row (if present).

Cannot be set to same value as TEXT_DELIMITER.

For DELIMITED_TEXT FILE_TYPE only. The default value is ’|’.

Definition at line 1312 of file CreateTableExternal.cs.

◆ TEXT_NULL_STRING

const string kinetica.CreateTableExternalRequest.Options.TEXT_NULL_STRING = “text_null_string”

static

Specifies the character string that should be interpreted as a null value in the source data.

For DELIMITED_TEXT FILE_TYPE only. The default value is ‘\N’.

Definition at line 1321 of file CreateTableExternal.cs.

◆ TEXT_QUOTE_CHARACTER

const string kinetica.CreateTableExternalRequest.Options.TEXT_QUOTE_CHARACTER = “text_quote_character”

static

Specifies the character that should be interpreted as a field value quoting character in the source data.

The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string.

For DELIMITED_TEXT FILE_TYPE only. The default value is ’”’.

Definition at line 1336 of file CreateTableExternal.cs.

◆ TEXT_SEARCH_COLUMNS

const string kinetica.CreateTableExternalRequest.Options.TEXT_SEARCH_COLUMNS = “text_search_columns”

static

Add ‘text_search’ property to internally inferenced string columns.

Comma separated list of column names or ’*’ for all columns. To add ‘text_search’ property only to string columns greater than or equal to a minimum size, also set the TEXT_SEARCH_MIN_COLUMN_LENGTH

Definition at line 1345 of file CreateTableExternal.cs.

◆ TEXT_SEARCH_MIN_COLUMN_LENGTH

const string kinetica.CreateTableExternalRequest.Options.TEXT_SEARCH_MIN_COLUMN_LENGTH = “text_search_min_column_length”

static

Set the minimum column size for strings to apply the ‘text_search’ property to.

Used only when TEXT_SEARCH_COLUMNS has a value.

Definition at line 1352 of file CreateTableExternal.cs.

◆ TRANSFORMATIONS

const string kinetica.CreateTableExternalRequest.Options.TRANSFORMATIONS = “transformations”

static

Comma-separated expressions, one per target table column.

Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ( $1 for the first input column,$ 2 for the second, etc.). The default value is ”.

Definition at line 1362 of file CreateTableExternal.cs.

◆ TRIM_SPACE

const string kinetica.CreateTableExternalRequest.Options.TRIM_SPACE = “trim_space”

static

If set to TRUE, remove leading or trailing space from fields.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 1383 of file CreateTableExternal.cs.

◆ TRUE

const string kinetica.CreateTableExternalRequest.Options.TRUE = “true”

static

A boolean constant for the CreateTableExternalRequest.Options options.

Definition at line 569 of file CreateTableExternal.cs.

◆ TRUNCATE_STRINGS

const string kinetica.CreateTableExternalRequest.Options.TRUNCATE_STRINGS = “truncate_strings”

static

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 1405 of file CreateTableExternal.cs.

◆ TRUNCATE_TABLE

const string kinetica.CreateTableExternalRequest.Options.TRUNCATE_TABLE = “truncate_table”

static

If set to TRUE, truncates the table specified by CreateTableExternalRequest.table_name prior to loading the file(s).

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 1428 of file CreateTableExternal.cs.

◆ TYPE_INFERENCE_MAX_RECORDS_READ

const string kinetica.CreateTableExternalRequest.Options.TYPE_INFERENCE_MAX_RECORDS_READ = “type_inference_max_records_read”

static

A constant for the CreateTableExternalRequest.Options options.

Definition at line 1432 of file CreateTableExternal.cs.

◆ TYPE_INFERENCE_MODE

const string kinetica.CreateTableExternalRequest.Options.TYPE_INFERENCE_MODE = “type_inference_mode”

static

Optimize type inferencing for either speed or accuracy.

Supported values:

ACCURACY: Scans data to get exactly-typed and sized columns for all data scanned.
SPEED: Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned.

The default value is SPEED.

Definition at line 1457 of file CreateTableExternal.cs.

◆ TYPE_INFERENCE_ONLY

const string kinetica.CreateTableExternalRequest.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 860 of file CreateTableExternal.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.CreateTableExternalRequest.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 1504 of file CreateTableExternal.cs.

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

Kinetica/Protocol/CreateTableExternal.cs

​Static Public Attributes

​Detailed Description

​Member Data Documentation

​◆ ABORT

​◆ ACCURACY

​◆ AUTO

​◆ AVRO

​◆ AVRO_SCHEMA

​◆ AVRO_SCHEMA_NO_INFERENCE

​◆ BAD_RECORD_TABLE_LIMIT

​◆ BAD_RECORD_TABLE_LIMIT_PER_INPUT

​◆ BAD_RECORD_TABLE_NAME

​◆ BATCH_SIZE

​◆ BZIP2

​◆ COLUMN_FORMATS

​◆ COLUMNS_TO_LOAD

​◆ COLUMNS_TO_SKIP

​◆ COMPRESSION_TYPE

​◆ DATALAKE_CATALOG

​◆ DATALAKE_PATH

​◆ DATALAKE_SNAPSHOT

​◆ DATASOURCE_NAME

​◆ DEFAULT_COLUMN_FORMATS

​◆ DELIMITED_TEXT

​◆ DISTRIBUTED_LOCAL

​◆ DISTRIBUTED_SHARED

​◆ DRY_RUN

​◆ EARLIEST

​◆ ENABLE_INPLACE_UPDATES

​◆ ERROR_HANDLING

​◆ EXTERNAL_TABLE_TYPE

​◆ FALSE

​◆ FILE_TYPE

​◆ FLATTEN_COLUMNS

​◆ FULL

​◆ GDAL_CONFIGURATION_OPTIONS

​◆ GDB

​◆ GZIP

​◆ HEAD

​◆ IGNORE_BAD_RECORDS

​◆ IGNORE_EXISTING_PK

​◆ INGESTION_MODE

​◆ JDBC_FETCH_SIZE

​◆ JSON

​◆ KAFKA_CONSUMERS_PER_RANK

​◆ KAFKA_GROUP_ID

​◆ KAFKA_OFFSET_RESET_POLICY

​◆ KAFKA_OPTIMISTIC_INGEST

​◆ KAFKA_SUBSCRIPTION_CANCEL_AFTER

​◆ KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT

​◆ LATEST

​◆ LAYER

​◆ LOADING_MODE

​◆ LOCAL_TIME_OFFSET

​◆ LOGICAL

​◆ MANUAL

​◆ MATERIALIZED

​◆ MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE

​◆ MAX_RECORDS_TO_LOAD

​◆ NAME_COLUMNS_FROM_FILE

​◆ NONE

​◆ NUM_TASKS_PER_RANK

​◆ ON_START

​◆ PARQUET

​◆ PERMISSIVE

​◆ PK_CONFLICT_PREDICATE_HIGHER

​◆ PK_CONFLICT_PREDICATE_LOWER

​◆ POLL_INTERVAL

​◆ PRIMARY_KEYS

​◆ REFRESH_METHOD

​◆ REMOTE_QUERY

​◆ REMOTE_QUERY_FILTER_COLUMN

​◆ REMOTE_QUERY_INCREASING_COLUMN

​◆ REMOTE_QUERY_PARTITION_COLUMN

​◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

​◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

​◆ SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES

​◆ SCHEMA_REGISTRY_SCHEMA_NAME

​◆ SHAPEFILE

​◆ SHARD_KEYS

Static Public Attributes

Detailed Description

Member Data Documentation

◆ ABORT

◆ ACCURACY

◆ AUTO

◆ AVRO

◆ AVRO_SCHEMA

◆ AVRO_SCHEMA_NO_INFERENCE

◆ BAD_RECORD_TABLE_LIMIT

◆ BAD_RECORD_TABLE_LIMIT_PER_INPUT

◆ BAD_RECORD_TABLE_NAME

◆ BATCH_SIZE

◆ BZIP2

◆ COLUMN_FORMATS

◆ COLUMNS_TO_LOAD

◆ COLUMNS_TO_SKIP

◆ COMPRESSION_TYPE

◆ DATALAKE_CATALOG

◆ DATALAKE_PATH

◆ DATALAKE_SNAPSHOT

◆ DATASOURCE_NAME

◆ DEFAULT_COLUMN_FORMATS

◆ DELIMITED_TEXT

◆ DISTRIBUTED_LOCAL

◆ DISTRIBUTED_SHARED

◆ DRY_RUN

◆ EARLIEST

◆ ENABLE_INPLACE_UPDATES

◆ ERROR_HANDLING

◆ EXTERNAL_TABLE_TYPE

◆ FALSE

◆ FILE_TYPE

◆ FLATTEN_COLUMNS

◆ FULL

◆ GDAL_CONFIGURATION_OPTIONS

◆ GDB

◆ GZIP

◆ HEAD

◆ IGNORE_BAD_RECORDS

◆ IGNORE_EXISTING_PK

◆ INGESTION_MODE

◆ JDBC_FETCH_SIZE

◆ JSON

◆ KAFKA_CONSUMERS_PER_RANK

◆ KAFKA_GROUP_ID

◆ KAFKA_OFFSET_RESET_POLICY

◆ KAFKA_OPTIMISTIC_INGEST

◆ KAFKA_SUBSCRIPTION_CANCEL_AFTER

◆ KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT

◆ LATEST

◆ LAYER

◆ LOADING_MODE

◆ LOCAL_TIME_OFFSET

◆ LOGICAL

◆ MANUAL

◆ MATERIALIZED

◆ MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE

◆ MAX_RECORDS_TO_LOAD

◆ NAME_COLUMNS_FROM_FILE

◆ NONE

◆ NUM_TASKS_PER_RANK

◆ ON_START

◆ PARQUET

◆ PERMISSIVE

◆ PK_CONFLICT_PREDICATE_HIGHER

◆ PK_CONFLICT_PREDICATE_LOWER

◆ POLL_INTERVAL

◆ PRIMARY_KEYS

◆ REFRESH_METHOD

◆ REMOTE_QUERY

◆ REMOTE_QUERY_FILTER_COLUMN

◆ REMOTE_QUERY_INCREASING_COLUMN

◆ REMOTE_QUERY_PARTITION_COLUMN

◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

◆ SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES

◆ SCHEMA_REGISTRY_SCHEMA_NAME

◆ SHAPEFILE

◆ SHARD_KEYS