> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.InsertRecordsFromPayloadRequest.Options > kinetica.InsertRecordsFromPayloadRequest.Options — Kinetica C# API

A set of string constants for the parameter InsertRecordsFromPayloadRequest.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  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  BATCH\_SIZE = "batch\_size"
  Internal tuning parameter–number of records 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 columns from the source data to load.
 
const string  COLUMNS\_TO\_SKIP = "columns\_to\_skip"
  Specifies a comma-delimited list of columns from the source data to skip.
 
const string  COMPRESSION\_TYPE = "compression\_type"
  Payload compression type.
 
const string  NONE = "none"
  Uncompressed.
 
const string  AUTO = "auto"
  Default.
 
const string  GZIP = "gzip"
  gzip file compression.
 
const string  BZIP2 = "bzip2"
  bzip2 file compression.
 
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  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  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  TRUE = "true"
  A boolean constant for the InsertRecordsFromPayloadRequest.Options options.
 
const string  FALSE = "false"
  A boolean constant for the InsertRecordsFromPayloadRequest.Options options.
 
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  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"
  For Avro local timestamp columns.
 
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 a 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  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  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  MAX\_CONSECUTIVE\_INVALID\_SCHEMA\_FAILURE = "max\_consecutive\_invalid\_schema\_failure"
  Max records to skip due to schema related errors, 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  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"
  When inserting records from multiple files: if TABLE\_PER\_FILE, then insert from each file into a new table.
 
const string  SINGLE = "single"
  A constant for the InsertRecordsFromPayloadRequest.Options options.
 
const string  TABLE\_PER\_FILE = "table\_per\_file"
  A constant for the InsertRecordsFromPayloadRequest.Options options.
 
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 minimum column size.
 
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 InsertRecordsFromPayloadRequest.table\_name prior to loading the file(s).
 
const string  TYPE\_INFERENCE\_MAX\_RECORDS\_READ = "type\_inference\_max\_records\_read"
  The default value is ''.
 
const string  TYPE\_INFERENCE\_MODE = "type\_inference\_mode"
  Optimize type inference mode.
 
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  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.
 
const string  TRANSFORMATIONS = "transformations"
  Comma-separated expressions, one per target table column.
 

Detailed Description

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

Optional parameters.

Definition at line 296 of file InsertRecordsFromPayload.cs.

Member Data Documentation

◆ ABORT

const string kinetica.InsertRecordsFromPayloadRequest.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 493 of file InsertRecordsFromPayload.cs.

◆ ACCURACY

const string kinetica.InsertRecordsFromPayloadRequest.Options.ACCURACY = "accuracy"
static

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

Definition at line 1127 of file InsertRecordsFromPayload.cs.

◆ AUTO

const string kinetica.InsertRecordsFromPayloadRequest.Options.AUTO = "auto"
static

Default.

Auto detect compression type.

Definition at line 411 of file InsertRecordsFromPayload.cs.

◆ AVRO

const string kinetica.InsertRecordsFromPayloadRequest.Options.AVRO = "avro"
static

Avro file format.

Definition at line 543 of file InsertRecordsFromPayload.cs.

◆ BAD\_RECORD\_TABLE\_LIMIT

const string kinetica.InsertRecordsFromPayloadRequest.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 308 of file InsertRecordsFromPayload.cs.

◆ BAD\_RECORD\_TABLE\_LIMIT\_PER\_INPUT

const string kinetica.InsertRecordsFromPayloadRequest.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 316 of file InsertRecordsFromPayload.cs.

◆ BAD\_RECORD\_TABLE\_NAME

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

Definition at line 303 of file InsertRecordsFromPayload.cs.

◆ BATCH\_SIZE

const string kinetica.InsertRecordsFromPayloadRequest.Options.BATCH\_SIZE = "batch\_size"
static

Internal tuning parameter–number of records per batch when inserting data.

Definition at line 320 of file InsertRecordsFromPayload.cs.

◆ BZIP2

const string kinetica.InsertRecordsFromPayloadRequest.Options.BZIP2 = "bzip2"
static

bzip2 file compression.

Definition at line 417 of file InsertRecordsFromPayload.cs.

◆ COLUMN\_FORMATS

const string kinetica.InsertRecordsFromPayloadRequest.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 336 of file InsertRecordsFromPayload.cs.

◆ COLUMNS\_TO\_LOAD

const string kinetica.InsertRecordsFromPayloadRequest.Options.COLUMNS\_TO\_LOAD = "columns\_to\_load"
static

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

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

Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table.

If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful.

Mutually exclusive with COLUMNS\_TO\_SKIP.

Definition at line 363 of file InsertRecordsFromPayload.cs.

◆ COLUMNS\_TO\_SKIP

const string kinetica.InsertRecordsFromPayloadRequest.Options.COLUMNS\_TO\_SKIP = "columns\_to\_skip"
static

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

Mutually exclusive with COLUMNS\_TO\_LOAD.

Definition at line 370 of file InsertRecordsFromPayload.cs.

◆ COMPRESSION\_TYPE

const string kinetica.InsertRecordsFromPayloadRequest.Options.COMPRESSION\_TYPE = "compression\_type"
static

Payload compression type.

Supported values:

  • NONE: Uncompressed.
  • AUTO: Default. Auto detect compression type.
  • GZIP: gzip file compression.
  • BZIP2: bzip2 file compression.

The default value is AUTO.

Definition at line 404 of file InsertRecordsFromPayload.cs.

◆ DEFAULT\_COLUMN\_FORMATS

const string kinetica.InsertRecordsFromPayloadRequest.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 447 of file InsertRecordsFromPayload.cs.

◆ DELIMITED\_TEXT

const string kinetica.InsertRecordsFromPayloadRequest.Options.DELIMITED\_TEXT = "delimited\_text"
static

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

Definition at line 547 of file InsertRecordsFromPayload.cs.

◆ DISTRIBUTED\_LOCAL

const string kinetica.InsertRecordsFromPayloadRequest.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 790 of file InsertRecordsFromPayload.cs.

◆ DISTRIBUTED\_SHARED

const string kinetica.InsertRecordsFromPayloadRequest.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 771 of file InsertRecordsFromPayload.cs.

◆ DRY\_RUN

const string kinetica.InsertRecordsFromPayloadRequest.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 691 of file InsertRecordsFromPayload.cs.

◆ ENABLE\_INPLACE\_UPDATES

const string kinetica.InsertRecordsFromPayloadRequest.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 1157 of file InsertRecordsFromPayload.cs.

◆ ERROR\_HANDLING

const string kinetica.InsertRecordsFromPayloadRequest.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 480 of file InsertRecordsFromPayload.cs.

◆ FALSE

const string kinetica.InsertRecordsFromPayloadRequest.Options.FALSE = "false"
static

A boolean constant for the InsertRecordsFromPayloadRequest.Options options.

Definition at line 592 of file InsertRecordsFromPayload.cs.

◆ FILE\_TYPE

const string kinetica.InsertRecordsFromPayloadRequest.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 540 of file InsertRecordsFromPayload.cs.

◆ FLATTEN\_COLUMNS

const string kinetica.InsertRecordsFromPayloadRequest.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 582 of file InsertRecordsFromPayload.cs.

◆ FULL

const string kinetica.InsertRecordsFromPayloadRequest.Options.FULL = "full"
static

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

Definition at line 684 of file InsertRecordsFromPayload.cs.

◆ GDAL\_CONFIGURATION\_OPTIONS

const string kinetica.InsertRecordsFromPayloadRequest.Options.GDAL\_CONFIGURATION\_OPTIONS = "gdal\_configuration\_options"
static

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

The default value is ''.

Definition at line 597 of file InsertRecordsFromPayload.cs.

◆ GDB

const string kinetica.InsertRecordsFromPayloadRequest.Options.GDB = "gdb"
static

Esri/GDB file format.

Definition at line 550 of file InsertRecordsFromPayload.cs.

◆ GZIP

const string kinetica.InsertRecordsFromPayloadRequest.Options.GZIP = "gzip"
static

gzip file compression.

Definition at line 414 of file InsertRecordsFromPayload.cs.

◆ HEAD

const string kinetica.InsertRecordsFromPayloadRequest.Options.HEAD = "head"
static

The head node loads all data.

All files must be available to the head node.

Definition at line 761 of file InsertRecordsFromPayload.cs.

◆ IGNORE\_BAD\_RECORDS

const string kinetica.InsertRecordsFromPayloadRequest.Options.IGNORE\_BAD\_RECORDS = "ignore\_bad\_records"
static

Malformed records are skipped.

Definition at line 487 of file InsertRecordsFromPayload.cs.

◆ IGNORE\_EXISTING\_PK

const string kinetica.InsertRecordsFromPayloadRequest.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 645 of file InsertRecordsFromPayload.cs.

◆ INGESTION\_MODE

const string kinetica.InsertRecordsFromPayloadRequest.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 680 of file InsertRecordsFromPayload.cs.

◆ JSON

const string kinetica.InsertRecordsFromPayloadRequest.Options.JSON = "json"
static

JSON file format.

Definition at line 553 of file InsertRecordsFromPayload.cs.

◆ LAYER

const string kinetica.InsertRecordsFromPayloadRequest.Options.LAYER = "layer"
static

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

The default value is ''.

Definition at line 701 of file InsertRecordsFromPayload.cs.

◆ LOADING\_MODE

const string kinetica.InsertRecordsFromPayloadRequest.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 756 of file InsertRecordsFromPayload.cs.

◆ LOCAL\_TIME\_OFFSET

const string kinetica.InsertRecordsFromPayloadRequest.Options.LOCAL\_TIME\_OFFSET = "local\_time\_offset"
static

For Avro local timestamp columns.

Definition at line 793 of file InsertRecordsFromPayload.cs.

◆ MAX\_CONSECUTIVE\_INVALID\_SCHEMA\_FAILURE

const string kinetica.InsertRecordsFromPayloadRequest.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 852 of file InsertRecordsFromPayload.cs.

◆ MAX\_RECORDS\_TO\_LOAD

const string kinetica.InsertRecordsFromPayloadRequest.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 a batch\_size, then the number of records loaded will be limited to the next whole number of batch\_size (per working thread).

The default value is ''.

Definition at line 800 of file InsertRecordsFromPayload.cs.

◆ NAME\_COLUMNS\_FROM\_FILE

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

If the payload has a header row (i.e., TEXT\_HAS\_HEADER is TRUE), these names override the payload's header names. If the payload has no header row, these names are used as the source-data column names. Either way, the i-th name in this list applies to the i-th column in the payload, enabling name-based matching against the target table's columns (and use with COLUMNS\_TO\_LOAD / COLUMNS\_TO\_SKIP).

Definition at line 817 of file InsertRecordsFromPayload.cs.

◆ NONE

const string kinetica.InsertRecordsFromPayloadRequest.Options.NONE = "none"
static

Uncompressed.

Definition at line 407 of file InsertRecordsFromPayload.cs.

◆ NUM\_TASKS\_PER\_RANK

const string kinetica.InsertRecordsFromPayloadRequest.Options.NUM\_TASKS\_PER\_RANK = "num\_tasks\_per\_rank"
static

Number of tasks for reading file per rank.

Default will be external\_file\_reader\_num\_tasks.

Definition at line 822 of file InsertRecordsFromPayload.cs.

◆ PARQUET

const string kinetica.InsertRecordsFromPayloadRequest.Options.PARQUET = "parquet"
static

Apache Parquet file format.

Definition at line 556 of file InsertRecordsFromPayload.cs.

◆ PERMISSIVE

const string kinetica.InsertRecordsFromPayloadRequest.Options.PERMISSIVE = "permissive"
static

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

Definition at line 484 of file InsertRecordsFromPayload.cs.

◆ POLL\_INTERVAL

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

Definition at line 831 of file InsertRecordsFromPayload.cs.

◆ PRIMARY\_KEYS

const string kinetica.InsertRecordsFromPayloadRequest.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 836 of file InsertRecordsFromPayload.cs.

◆ SCHEMA\_REGISTRY\_CONNECTION\_RETRIES

const string kinetica.InsertRecordsFromPayloadRequest.Options.SCHEMA\_REGISTRY\_CONNECTION\_RETRIES = "schema\_registry\_connection\_retries"
static

Confluent Schema registry connection timeout (in secs).

Definition at line 840 of file InsertRecordsFromPayload.cs.

◆ SCHEMA\_REGISTRY\_CONNECTION\_TIMEOUT

const string kinetica.InsertRecordsFromPayloadRequest.Options.SCHEMA\_REGISTRY\_CONNECTION\_TIMEOUT = "schema\_registry\_connection\_timeout"
static

Confluent Schema registry connection timeout (in secs).

Definition at line 844 of file InsertRecordsFromPayload.cs.

◆ SCHEMA\_REGISTRY\_MAX\_CONSECUTIVE\_CONNECTION\_FAILURES

const string kinetica.InsertRecordsFromPayloadRequest.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 848 of file InsertRecordsFromPayload.cs.

◆ SCHEMA\_REGISTRY\_SCHEMA\_NAME

const string kinetica.InsertRecordsFromPayloadRequest.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 856 of file InsertRecordsFromPayload.cs.

◆ SHAPEFILE

const string kinetica.InsertRecordsFromPayloadRequest.Options.SHAPEFILE = "shapefile"
static

ShapeFile file format.

Definition at line 559 of file InsertRecordsFromPayload.cs.

◆ SHARD\_KEYS

const string kinetica.InsertRecordsFromPayloadRequest.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 861 of file InsertRecordsFromPayload.cs.

◆ SINGLE

const string kinetica.InsertRecordsFromPayloadRequest.Options.SINGLE = "single"
static

A constant for the InsertRecordsFromPayloadRequest.Options options.

Definition at line 912 of file InsertRecordsFromPayload.cs.

◆ SKIP\_LINES

const string kinetica.InsertRecordsFromPayloadRequest.Options.SKIP\_LINES = "skip\_lines"
static

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

Definition at line 865 of file InsertRecordsFromPayload.cs.

◆ SPEED

const string kinetica.InsertRecordsFromPayloadRequest.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 1131 of file InsertRecordsFromPayload.cs.

◆ SUBSCRIBE

const string kinetica.InsertRecordsFromPayloadRequest.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 885 of file InsertRecordsFromPayload.cs.

◆ TABLE\_INSERT\_MODE

const string kinetica.InsertRecordsFromPayloadRequest.Options.TABLE\_INSERT\_MODE = "table\_insert\_mode"
static

When inserting records from multiple files: if TABLE\_PER\_FILE, then insert from each file into a new table.

Currently supported only for shapefiles. Supported values:

The default value is SINGLE.

Definition at line 907 of file InsertRecordsFromPayload.cs.

◆ TABLE\_PER\_FILE

const string kinetica.InsertRecordsFromPayloadRequest.Options.TABLE\_PER\_FILE = "table\_per\_file"
static

A constant for the InsertRecordsFromPayloadRequest.Options options.

Definition at line 917 of file InsertRecordsFromPayload.cs.

◆ TEXT\_COMMENT\_STRING

const string kinetica.InsertRecordsFromPayloadRequest.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 928 of file InsertRecordsFromPayload.cs.

◆ TEXT\_DELIMITER

const string kinetica.InsertRecordsFromPayloadRequest.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 937 of file InsertRecordsFromPayload.cs.

◆ TEXT\_ESCAPE\_CHARACTER

const string kinetica.InsertRecordsFromPayloadRequest.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 955 of file InsertRecordsFromPayload.cs.

◆ TEXT\_HAS\_HEADER

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

The default value is TRUE.

Definition at line 980 of file InsertRecordsFromPayload.cs.

◆ TEXT\_HEADER\_PROPERTY\_DELIMITER

const string kinetica.InsertRecordsFromPayloadRequest.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 993 of file InsertRecordsFromPayload.cs.

◆ TEXT\_NULL\_STRING

const string kinetica.InsertRecordsFromPayloadRequest.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 1002 of file InsertRecordsFromPayload.cs.

◆ TEXT\_QUOTE\_CHARACTER

const string kinetica.InsertRecordsFromPayloadRequest.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 1017 of file InsertRecordsFromPayload.cs.

◆ TEXT\_SEARCH\_COLUMNS

const string kinetica.InsertRecordsFromPayloadRequest.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 of minimum size, set also the option 'text\_search\_min\_column\_length'.

Definition at line 1025 of file InsertRecordsFromPayload.cs.

◆ TEXT\_SEARCH\_MIN\_COLUMN\_LENGTH

const string kinetica.InsertRecordsFromPayloadRequest.Options.TEXT\_SEARCH\_MIN\_COLUMN\_LENGTH = "text\_search\_min\_column\_length"
static

Set minimum column size.

Used only when 'text\_search\_columns' has a value.

Definition at line 1030 of file InsertRecordsFromPayload.cs.

◆ TRANSFORMATIONS

const string kinetica.InsertRecordsFromPayloadRequest.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 1206 of file InsertRecordsFromPayload.cs.

◆ TRIM\_SPACE

const string kinetica.InsertRecordsFromPayloadRequest.Options.TRIM\_SPACE = "trim\_space"
static

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

Supported values:

The default value is FALSE.

Definition at line 1051 of file InsertRecordsFromPayload.cs.

◆ TRUE

const string kinetica.InsertRecordsFromPayloadRequest.Options.TRUE = "true"
static

A boolean constant for the InsertRecordsFromPayloadRequest.Options options.

Definition at line 587 of file InsertRecordsFromPayload.cs.

◆ TRUNCATE\_STRINGS

const string kinetica.InsertRecordsFromPayloadRequest.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 1073 of file InsertRecordsFromPayload.cs.

◆ TRUNCATE\_TABLE

const string kinetica.InsertRecordsFromPayloadRequest.Options.TRUNCATE\_TABLE = "truncate\_table"
static

If set to TRUE, truncates the table specified by InsertRecordsFromPayloadRequest.table\_name prior to loading the file(s).

Supported values:

The default value is FALSE.

Definition at line 1096 of file InsertRecordsFromPayload.cs.

◆ TYPE\_INFERENCE\_MAX\_RECORDS\_READ

const string kinetica.InsertRecordsFromPayloadRequest.Options.TYPE\_INFERENCE\_MAX\_RECORDS\_READ = "type\_inference\_max\_records\_read"
static

The default value is ''.

Definition at line 1099 of file InsertRecordsFromPayload.cs.

◆ TYPE\_INFERENCE\_MODE

const string kinetica.InsertRecordsFromPayloadRequest.Options.TYPE\_INFERENCE\_MODE = "type\_inference\_mode"
static

Optimize type inference mode.

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

Definition at line 1123 of file InsertRecordsFromPayload.cs.

◆ TYPE\_INFERENCE\_ONLY

const string kinetica.InsertRecordsFromPayloadRequest.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 697 of file InsertRecordsFromPayload.cs.

◆ UPDATE\_ON\_EXISTING\_PK

const string kinetica.InsertRecordsFromPayloadRequest.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 1196 of file InsertRecordsFromPayload.cs.

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