> ## 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 > kinetica.InsertRecordsFromPayloadRequest — Kinetica C# API

A set of parameters for Kinetica.insertRecordsFromPayload. More...

Inheritance diagram for kinetica.InsertRecordsFromPayloadRequest:
Collaboration diagram for kinetica.InsertRecordsFromPayloadRequest:

Classes
struct   CreateTableOptions
  A set of string constants for the parameter InsertRecordsFromPayloadRequest.create\_table\_options. More...
 
struct   Options
  A set of string constants for the parameter InsertRecordsFromPayloadRequest.options. More...
 

Public Member Functions
  InsertRecordsFromPayloadRequest ()
  Constructs an InsertRecordsFromPayloadRequest object with default parameters.
 
  InsertRecordsFromPayloadRequest (string table\_name, string data\_text, byte\[] data\_bytes, IDictionary\< string, IDictionary\< string, string > > modify\_columns=null, IDictionary\< string, string > create\_table\_options=null, IDictionary\< string, string > options=null)
  Constructs an InsertRecordsFromPayloadRequest object with the specified parameters.
 
  InsertRecordsFromPayloadRequest ()
  Constructs an InsertRecordsFromPayloadRequest object with default parameters.
 
  InsertRecordsFromPayloadRequest (string table\_name, string data\_text, byte\[] data\_bytes, IDictionary\< string, IDictionary\< string, string > > modify\_columns=null, IDictionary\< string, string > create\_table\_options=null, IDictionary\< string, string > options=null)
  Constructs an InsertRecordsFromPayloadRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of the table into which the data will be inserted, in \[schema\_name.
 
string  data\_text \[get, set]
  Records formatted as delimited text.
 
byte\[]  data\_bytes \[get, set]
  Records formatted as binary data.
 
IDictionary\< string, IDictionary\< string, string > >  modify\_columns = new Dictionary\>() \[get, set]
  Not implemented yet.
 
IDictionary\< string, string >  create\_table\_options = new Dictionary\() \[get, set]
  Options used when creating the target table.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.insertRecordsFromPayload.

Reads from the given text-based or binary payload and inserts the data into a new or existing table. The table will be created if it doesn't already exist.

Returns once all records are processed.

Definition at line 18 of file InsertRecordsFromPayload.cs.

Constructor & Destructor Documentation

◆ InsertRecordsFromPayloadRequest() \[1/4]

kinetica.InsertRecordsFromPayloadRequest.InsertRecordsFromPayloadRequest ( )
inline

Constructs an InsertRecordsFromPayloadRequest object with default parameters.

Definition at line 2427 of file InsertRecordsFromPayload.cs.

◆ InsertRecordsFromPayloadRequest() \[2/4]

kinetica.InsertRecordsFromPayloadRequest.InsertRecordsFromPayloadRequest ( string table\_name,
string data\_text,
byte\[] data\_bytes,
IDictionary\< string, IDictionary\< string, string > > modify\_columns = null,
IDictionary\< string, string > create\_table\_options = null,
IDictionary\< string, string > options = null )
inline

Constructs an InsertRecordsFromPayloadRequest object with the specified parameters.

Parameters
table\_name Name of the table into which the data will be inserted, in \[schema\_name.]table\_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing TYPE\_ID or the type inferred from the payload, and the new table name will have to meet standard table naming criteria.
data\_text Records formatted as delimited text.
data\_bytes Records formatted as binary data.
modify\_columns Not implemented yet. The default value is an empty Dictionary.
create\_table\_options Options used when creating the target table. Includes type to use. The other options match those in Kinetica.createTable. The default value is an empty Dictionary.
options Optional parameters.
  • BAD\_RECORD\_TABLE\_NAME: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string).
  • BAD\_RECORD\_TABLE\_LIMIT: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
  • 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. Default value will be 'bad\_record\_table\_limit' and total size of the table per rank is limited to 'bad\_record\_table\_limit'.
  • BATCH\_SIZE: Internal tuning parameter–number of records per batch when inserting data.
  • COLUMN\_FORMATS: 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.
  • COLUMNS\_TO\_LOAD: 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.
  • COLUMNS\_TO\_SKIP: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with COLUMNS\_TO\_LOAD.
  • COMPRESSION\_TYPE: 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.
  • DEFAULT\_COLUMN\_FORMATS: 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"
  • ERROR\_HANDLING: Specifies how errors should be handled upon insertion. Supported values:
    • PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
    • IGNORE\_BAD\_RECORDS: Malformed records are skipped.
    • ABORT: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
    The default value is ABORT.
  • FILE\_TYPE: 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.
  • FLATTEN\_COLUMNS: 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.
  • GDAL\_CONFIGURATION\_OPTIONS: Comma separated list of gdal conf options, for the specific requests: key=value. The default value is ''.
  • IGNORE\_EXISTING\_PK: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE\_ON\_EXISTING\_PK is FALSE). If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ERROR\_HANDLING. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE\_ON\_EXISTING\_PK is TRUE), then this option has no effect. Supported values:
    • TRUE: Ignore new records whose primary key values collide with those of existing records.
    • FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is FALSE.
  • INGESTION\_MODE: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • FULL: Run a type inference on the source data (if needed) and ingest.
    • DRY\_RUN: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of ERROR\_HANDLING.
    • TYPE\_INFERENCE\_ONLY: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is FULL.
  • LAYER: Geo files layer(s) name(s): comma separated. The default value is ''.
  • LOADING\_MODE: 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.
  • LOCAL\_TIME\_OFFSET: For Avro local timestamp columns.
  • 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). The default value is ''.
  • NAME\_COLUMNS\_FROM\_FILE: 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).
  • NUM\_TASKS\_PER\_RANK: Number of tasks for reading file per rank. Default will be external\_file\_reader\_num\_tasks.
  • POLL\_INTERVAL: 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.
  • PRIMARY\_KEYS: Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
  • SCHEMA\_REGISTRY\_CONNECTION\_RETRIES: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_CONNECTION\_TIMEOUT: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_MAX\_CONSECUTIVE\_CONNECTION\_FAILURES: Max records to skip due to SR connection failures, before failing.
  • MAX\_CONSECUTIVE\_INVALID\_SCHEMA\_FAILURE: Max records to skip due to schema related errors, before failing.
  • SCHEMA\_REGISTRY\_SCHEMA\_NAME: Name of the Avro schema in the schema registry to use when reading Avro records.
  • SHARD\_KEYS: Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ''.
  • SKIP\_LINES: Skip a number of lines from the beginning of the file.
  • SUBSCRIBE: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is FALSE.
  • TABLE\_INSERT\_MODE: 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.
  • TEXT\_COMMENT\_STRING: 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 '#'.
  • TEXT\_DELIMITER: 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 ','.
  • TEXT\_ESCAPE\_CHARACTER: 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.
  • TEXT\_HAS\_HEADER: Indicates whether the source data contains a header row. For DELIMITED\_TEXTFILE\_TYPE only. Supported values: The default value is TRUE.
  • TEXT\_HEADER\_PROPERTY\_DELIMITER: 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 '|'.
  • TEXT\_NULL\_STRING: 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'.
  • TEXT\_QUOTE\_CHARACTER: 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 '"'.
  • TEXT\_SEARCH\_COLUMNS: 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'.
  • TEXT\_SEARCH\_MIN\_COLUMN\_LENGTH: Set minimum column size. Used only when 'text\_search\_columns' has a value.
  • TRIM\_SPACE: If set to TRUE, remove leading or trailing space from fields. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, truncate string values that are longer than the column's type size. Supported values: The default value is FALSE.
  • TRUNCATE\_TABLE: If set to TRUE, truncates the table specified by table\_name prior to loading the file(s). Supported values: The default value is FALSE.
  • TYPE\_INFERENCE\_MAX\_RECORDS\_READ: The default value is ''.
  • TYPE\_INFERENCE\_MODE: 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values: The default value is TRUE.
  • UPDATE\_ON\_EXISTING\_PK: Specifies the record collision policy for inserting into a table with a primary key. If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE\_EXISTING\_PK and ERROR\_HANDLING. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • TRUE: Upsert new records when primary keys match existing records.
    • FALSE: Reject new records when primary keys match existing records.
    The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 3641 of file InsertRecordsFromPayload.cs.

◆ InsertRecordsFromPayloadRequest() \[3/4]

kinetica.InsertRecordsFromPayloadRequest.InsertRecordsFromPayloadRequest ( )
inline

Constructs an InsertRecordsFromPayloadRequest object with default parameters.

Definition at line 2450 of file InsertRecordsFromPayload.cs.

◆ InsertRecordsFromPayloadRequest() \[4/4]

kinetica.InsertRecordsFromPayloadRequest.InsertRecordsFromPayloadRequest ( string table\_name,
string data\_text,
byte\[] data\_bytes,
IDictionary\< string, IDictionary\< string, string > > modify\_columns = null,
IDictionary\< string, string > create\_table\_options = null,
IDictionary\< string, string > options = null )
inline

Constructs an InsertRecordsFromPayloadRequest object with the specified parameters.

Parameters
table\_name Name of the table into which the data will be inserted, in \[schema\_name.]table\_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing TYPE\_ID or the type inferred from the payload, and the new table name will have to meet standard table naming criteria.
data\_text Records formatted as delimited text.
data\_bytes Records formatted as binary data.
modify\_columns Not implemented yet. The default value is an empty Dictionary.
create\_table\_options Options used when creating the target table. Includes type to use. The other options match those in Kinetica.createTable. The default value is an empty Dictionary.
options Optional parameters.
  • BAD\_RECORD\_TABLE\_NAME: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string).
  • BAD\_RECORD\_TABLE\_LIMIT: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
  • 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. Default value will be 'bad\_record\_table\_limit' and total size of the table per rank is limited to 'bad\_record\_table\_limit'.
  • BATCH\_SIZE: Internal tuning parameter–number of records per batch when inserting data.
  • COLUMN\_FORMATS: 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.
  • COLUMNS\_TO\_LOAD: 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.
  • COLUMNS\_TO\_SKIP: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with COLUMNS\_TO\_LOAD.
  • COMPRESSION\_TYPE: 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.
  • DEFAULT\_COLUMN\_FORMATS: 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"
  • ERROR\_HANDLING: Specifies how errors should be handled upon insertion. Supported values:
    • PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
    • IGNORE\_BAD\_RECORDS: Malformed records are skipped.
    • ABORT: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
    The default value is ABORT.
  • FILE\_TYPE: 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.
  • FLATTEN\_COLUMNS: 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.
  • GDAL\_CONFIGURATION\_OPTIONS: Comma separated list of gdal conf options, for the specific requests: key=value. The default value is ''.
  • IGNORE\_EXISTING\_PK: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE\_ON\_EXISTING\_PK is FALSE). If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ERROR\_HANDLING. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE\_ON\_EXISTING\_PK is TRUE), then this option has no effect. Supported values:
    • TRUE: Ignore new records whose primary key values collide with those of existing records.
    • FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is FALSE.
  • INGESTION\_MODE: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • FULL: Run a type inference on the source data (if needed) and ingest.
    • DRY\_RUN: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of ERROR\_HANDLING.
    • TYPE\_INFERENCE\_ONLY: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is FULL.
  • LAYER: Geo files layer(s) name(s): comma separated. The default value is ''.
  • LOADING\_MODE: 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.
  • LOCAL\_TIME\_OFFSET: For Avro local timestamp columns.
  • 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). The default value is ''.
  • NAME\_COLUMNS\_FROM\_FILE: 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).
  • NUM\_TASKS\_PER\_RANK: Number of tasks for reading file per rank. Default will be external\_file\_reader\_num\_tasks.
  • POLL\_INTERVAL: 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.
  • PRIMARY\_KEYS: Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
  • SCHEMA\_REGISTRY\_CONNECTION\_RETRIES: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_CONNECTION\_TIMEOUT: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_MAX\_CONSECUTIVE\_CONNECTION\_FAILURES: Max records to skip due to SR connection failures, before failing.
  • MAX\_CONSECUTIVE\_INVALID\_SCHEMA\_FAILURE: Max records to skip due to schema related errors, before failing.
  • SCHEMA\_REGISTRY\_SCHEMA\_NAME: Name of the Avro schema in the schema registry to use when reading Avro records.
  • SHARD\_KEYS: Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ''.
  • SKIP\_LINES: Skip a number of lines from the beginning of the file.
  • SUBSCRIBE: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is FALSE.
  • TABLE\_INSERT\_MODE: 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.
  • TEXT\_COMMENT\_STRING: 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 '#'.
  • TEXT\_DELIMITER: 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 ','.
  • TEXT\_ESCAPE\_CHARACTER: 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.
  • TEXT\_HAS\_HEADER: Indicates whether the source data contains a header row. For DELIMITED\_TEXTFILE\_TYPE only. Supported values: The default value is TRUE.
  • TEXT\_HEADER\_PROPERTY\_DELIMITER: 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 '|'.
  • TEXT\_NULL\_STRING: 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'.
  • TEXT\_QUOTE\_CHARACTER: 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 '"'.
  • TEXT\_SEARCH\_COLUMNS: 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'.
  • TEXT\_SEARCH\_MIN\_COLUMN\_LENGTH: Set minimum column size. Used only when 'text\_search\_columns' has a value.
  • TRIM\_SPACE: If set to TRUE, remove leading or trailing space from fields. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, truncate string values that are longer than the column's type size. Supported values: The default value is FALSE.
  • TRUNCATE\_TABLE: If set to TRUE, truncates the table specified by table\_name prior to loading the file(s). Supported values: The default value is FALSE.
  • TYPE\_INFERENCE\_MAX\_RECORDS\_READ: The default value is ''.
  • TYPE\_INFERENCE\_MODE: 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values: The default value is TRUE.
  • UPDATE\_ON\_EXISTING\_PK: Specifies the record collision policy for inserting into a table with a primary key. If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE\_EXISTING\_PK and ERROR\_HANDLING. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • TRUE: Upsert new records when primary keys match existing records.
    • FALSE: Reject new records when primary keys match existing records.
    The default value is FALSE.
  • TRANSFORMATIONS: 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 ''.
The default value is an empty Dictionary.

Definition at line 3677 of file InsertRecordsFromPayload.cs.

Property Documentation

◆ create\_table\_options

IDictionary\< string, string > kinetica.InsertRecordsFromPayloadRequest.create\_table\_options = new Dictionary\()
getset

Options used when creating the target table.

Includes type to use. The other options match those in Kinetica.createTable.

The default value is an empty Dictionary.

Definition at line 1505 of file InsertRecordsFromPayload.cs.

◆ data\_bytes

byte \[] kinetica.InsertRecordsFromPayloadRequest.data\_bytes
getset

Records formatted as binary data.

Definition at line 1216 of file InsertRecordsFromPayload.cs.

◆ data\_text

string kinetica.InsertRecordsFromPayloadRequest.data\_text
getset

Records formatted as delimited text.

Definition at line 1213 of file InsertRecordsFromPayload.cs.

◆ modify\_columns

IDictionary\< string, IDictionary\< string, string > > kinetica.InsertRecordsFromPayloadRequest.modify\_columns = new Dictionary\>()
getset

Not implemented yet.

The default value is an empty Dictionary.

Definition at line 1221 of file InsertRecordsFromPayload.cs.

◆ options

IDictionary\< string, string > kinetica.InsertRecordsFromPayloadRequest.options = new Dictionary\()
getset

Optional parameters.

  • BAD\_RECORD\_TABLE\_NAME: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string).
  • BAD\_RECORD\_TABLE\_LIMIT: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
  • 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. Default value will be 'bad\_record\_table\_limit' and total size of the table per rank is limited to 'bad\_record\_table\_limit'.
  • BATCH\_SIZE: Internal tuning parameter–number of records per batch when inserting data.
  • COLUMN\_FORMATS: 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.
  • COLUMNS\_TO\_LOAD: 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.
  • COLUMNS\_TO\_SKIP: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with COLUMNS\_TO\_LOAD.
  • COMPRESSION\_TYPE: 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.
  • DEFAULT\_COLUMN\_FORMATS: 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"
  • ERROR\_HANDLING: Specifies how errors should be handled upon insertion. Supported values:
    • PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
    • IGNORE\_BAD\_RECORDS: Malformed records are skipped.
    • ABORT: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
    The default value is ABORT.
  • FILE\_TYPE: 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.
  • FLATTEN\_COLUMNS: 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.
  • GDAL\_CONFIGURATION\_OPTIONS: Comma separated list of gdal conf options, for the specific requests: key=value. The default value is ''.
  • IGNORE\_EXISTING\_PK: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE\_ON\_EXISTING\_PK is FALSE). If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ERROR\_HANDLING. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE\_ON\_EXISTING\_PK is TRUE), then this option has no effect. Supported values:
    • TRUE: Ignore new records whose primary key values collide with those of existing records.
    • FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is FALSE.
  • INGESTION\_MODE: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • FULL: Run a type inference on the source data (if needed) and ingest.
    • DRY\_RUN: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of ERROR\_HANDLING.
    • TYPE\_INFERENCE\_ONLY: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is FULL.
  • LAYER: Geo files layer(s) name(s): comma separated. The default value is ''.
  • LOADING\_MODE: 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.
  • LOCAL\_TIME\_OFFSET: For Avro local timestamp columns.
  • 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). The default value is ''.
  • NAME\_COLUMNS\_FROM\_FILE: 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).
  • NUM\_TASKS\_PER\_RANK: Number of tasks for reading file per rank. Default will be external\_file\_reader\_num\_tasks.
  • POLL\_INTERVAL: 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.
  • PRIMARY\_KEYS: Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
  • SCHEMA\_REGISTRY\_CONNECTION\_RETRIES: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_CONNECTION\_TIMEOUT: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_MAX\_CONSECUTIVE\_CONNECTION\_FAILURES: Max records to skip due to SR connection failures, before failing.
  • MAX\_CONSECUTIVE\_INVALID\_SCHEMA\_FAILURE: Max records to skip due to schema related errors, before failing.
  • SCHEMA\_REGISTRY\_SCHEMA\_NAME: Name of the Avro schema in the schema registry to use when reading Avro records.
  • SHARD\_KEYS: Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ''.
  • SKIP\_LINES: Skip a number of lines from the beginning of the file.
  • SUBSCRIBE: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is FALSE.
  • TABLE\_INSERT\_MODE: 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.
  • TEXT\_COMMENT\_STRING: 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 '#'.
  • TEXT\_DELIMITER: 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 ','.
  • TEXT\_ESCAPE\_CHARACTER: 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.
  • TEXT\_HAS\_HEADER: Indicates whether the source data contains a header row. For DELIMITED\_TEXTFILE\_TYPE only. Supported values: The default value is TRUE.
  • TEXT\_HEADER\_PROPERTY\_DELIMITER: 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 '|'.
  • TEXT\_NULL\_STRING: 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'.
  • TEXT\_QUOTE\_CHARACTER: 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 '"'.
  • TEXT\_SEARCH\_COLUMNS: 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'.
  • TEXT\_SEARCH\_MIN\_COLUMN\_LENGTH: Set minimum column size. Used only when 'text\_search\_columns' has a value.
  • TRIM\_SPACE: If set to TRUE, remove leading or trailing space from fields. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, truncate string values that are longer than the column's type size. Supported values: The default value is FALSE.
  • TRUNCATE\_TABLE: 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.
  • TYPE\_INFERENCE\_MAX\_RECORDS\_READ: The default value is ''.
  • TYPE\_INFERENCE\_MODE: 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values: The default value is TRUE.
  • UPDATE\_ON\_EXISTING\_PK: Specifies the record collision policy for inserting into a table with a primary key. If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE\_EXISTING\_PK and ERROR\_HANDLING. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • TRUE: Upsert new records when primary keys match existing records.
    • FALSE: Reject new records when primary keys match existing records.
    The default value is FALSE.

The default value is an empty Dictionary.

  • BAD\_RECORD\_TABLE\_NAME: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string).
  • BAD\_RECORD\_TABLE\_LIMIT: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
  • 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. Default value will be 'bad\_record\_table\_limit' and total size of the table per rank is limited to 'bad\_record\_table\_limit'.
  • BATCH\_SIZE: Internal tuning parameter–number of records per batch when inserting data.
  • COLUMN\_FORMATS: 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.
  • COLUMNS\_TO\_LOAD: 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.
  • COLUMNS\_TO\_SKIP: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with COLUMNS\_TO\_LOAD.
  • COMPRESSION\_TYPE: 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.
  • DEFAULT\_COLUMN\_FORMATS: 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"
  • ERROR\_HANDLING: Specifies how errors should be handled upon insertion. Supported values:
    • PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
    • IGNORE\_BAD\_RECORDS: Malformed records are skipped.
    • ABORT: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
    The default value is ABORT.
  • FILE\_TYPE: 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.
  • FLATTEN\_COLUMNS: 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.
  • GDAL\_CONFIGURATION\_OPTIONS: Comma separated list of gdal conf options, for the specific requests: key=value. The default value is ''.
  • IGNORE\_EXISTING\_PK: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE\_ON\_EXISTING\_PK is FALSE). If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ERROR\_HANDLING. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE\_ON\_EXISTING\_PK is TRUE), then this option has no effect. Supported values:
    • TRUE: Ignore new records whose primary key values collide with those of existing records.
    • FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is FALSE.
  • INGESTION\_MODE: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • FULL: Run a type inference on the source data (if needed) and ingest.
    • DRY\_RUN: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of ERROR\_HANDLING.
    • TYPE\_INFERENCE\_ONLY: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is FULL.
  • LAYER: Geo files layer(s) name(s): comma separated. The default value is ''.
  • LOADING\_MODE: 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.
  • LOCAL\_TIME\_OFFSET: For Avro local timestamp columns.
  • 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). The default value is ''.
  • NAME\_COLUMNS\_FROM\_FILE: 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).
  • NUM\_TASKS\_PER\_RANK: Number of tasks for reading file per rank. Default will be external\_file\_reader\_num\_tasks.
  • POLL\_INTERVAL: 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.
  • PRIMARY\_KEYS: Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
  • SCHEMA\_REGISTRY\_CONNECTION\_RETRIES: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_CONNECTION\_TIMEOUT: Confluent Schema registry connection timeout (in secs).
  • SCHEMA\_REGISTRY\_MAX\_CONSECUTIVE\_CONNECTION\_FAILURES: Max records to skip due to SR connection failures, before failing.
  • MAX\_CONSECUTIVE\_INVALID\_SCHEMA\_FAILURE: Max records to skip due to schema related errors, before failing.
  • SCHEMA\_REGISTRY\_SCHEMA\_NAME: Name of the Avro schema in the schema registry to use when reading Avro records.
  • SHARD\_KEYS: Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ''.
  • SKIP\_LINES: Skip a number of lines from the beginning of the file.
  • SUBSCRIBE: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is FALSE.
  • TABLE\_INSERT\_MODE: 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.
  • TEXT\_COMMENT\_STRING: 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 '#'.
  • TEXT\_DELIMITER: 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 ','.
  • TEXT\_ESCAPE\_CHARACTER: 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.
  • TEXT\_HAS\_HEADER: Indicates whether the source data contains a header row. For DELIMITED\_TEXTFILE\_TYPE only. Supported values: The default value is TRUE.
  • TEXT\_HEADER\_PROPERTY\_DELIMITER: 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 '|'.
  • TEXT\_NULL\_STRING: 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'.
  • TEXT\_QUOTE\_CHARACTER: 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 '"'.
  • TEXT\_SEARCH\_COLUMNS: 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'.
  • TEXT\_SEARCH\_MIN\_COLUMN\_LENGTH: Set minimum column size. Used only when 'text\_search\_columns' has a value.
  • TRIM\_SPACE: If set to TRUE, remove leading or trailing space from fields. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, truncate string values that are longer than the column's type size. Supported values: The default value is FALSE.
  • TRUNCATE\_TABLE: 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.
  • TYPE\_INFERENCE\_MAX\_RECORDS\_READ: The default value is ''.
  • TYPE\_INFERENCE\_MODE: 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values: The default value is TRUE.
  • UPDATE\_ON\_EXISTING\_PK: Specifies the record collision policy for inserting into a table with a primary key. If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE\_EXISTING\_PK and ERROR\_HANDLING. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • TRUE: Upsert new records when primary keys match existing records.
    • FALSE: Reject new records when primary keys match existing records.
    The default value is FALSE.
  • TRANSFORMATIONS: 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 ''.

The default value is an empty Dictionary.

Definition at line 2423 of file InsertRecordsFromPayload.cs.

◆ table\_name

string kinetica.InsertRecordsFromPayloadRequest.table\_name
getset

Name of the table into which the data will be inserted, in \[schema\_name.

]table\_name format, using standard name resolution rules.

If the table does not exist, the table will be created using either an existing TYPE\_ID or the type inferred from the payload, and the new table name will have to meet standard table naming criteria.

Definition at line 1210 of file InsertRecordsFromPayload.cs.

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