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

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

Inheritance diagram for kinetica.RawInsertRecordsRequest:
Collaboration diagram for kinetica.RawInsertRecordsRequest:

Classes
struct   ListEncoding
  A set of string constants for the parameter RawInsertRecordsRequest.list\_encoding. More...
 
struct   Options
  A set of string constants for the parameter RawInsertRecordsRequest.options. More...
 

Public Member Functions
  RawInsertRecordsRequest ()
  Constructs a RawInsertRecordsRequest object with default parameters.
 
  RawInsertRecordsRequest (string table\_name, IList\< byte\[]> list, IDictionary\< string, string > options=null)
  Constructs a RawInsertRecordsRequest object with the specified parameters.
 
  RawInsertRecordsRequest (string table\_name, IList\< byte\[]> list, IList\< string > list\_str, string list\_encoding=null, IDictionary\< string, string > options=null)
  Constructs a RawInsertRecordsRequest object with the specified parameters.
 
  RawInsertRecordsRequest ()
  Constructs a RawInsertRecordsRequest object with default parameters.
 
  RawInsertRecordsRequest (string table\_name, IList\< byte\[]> list, IDictionary\< string, string > options=null)
  Constructs a RawInsertRecordsRequest object with the specified parameters.
 
  RawInsertRecordsRequest (string table\_name, IList\< byte\[]> list, IList\< string > list\_str, string list\_encoding=null, IDictionary\< string, string > options=null)
  Constructs a RawInsertRecordsRequest 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 table to which the records are to be added, in \[schema\_name.
 
IList\< byte\[]>  list = new List\() \[get, set]
  An array of binary-encoded data for the records to be added.
 
IList\< string >  list\_str = new List\() \[get, set]
  An array of JSON encoded data for the records to be added.
 
string  list\_encoding = ListEncoding.BINARY \[get, set]
  The encoding of the records to be inserted.
 
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.insertRecordsRaw.

Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The RawInsertRecordsRequest.options parameter can be used to customize this function's behavior.

The UPDATE\_ON\_EXISTING\_PK option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The RETURN\_RECORD\_IDS option indicates that the database should return the unique identifiers of inserted records.

Definition at line 31 of file InsertRecords.cs.

Constructor & Destructor Documentation

◆ RawInsertRecordsRequest() \[1/6]

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( )
inline

Constructs a RawInsertRecordsRequest object with default parameters.

Definition at line 696 of file InsertRecords.cs.

◆ RawInsertRecordsRequest() \[2/6]

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( string table\_name,
IList\< byte\[]> list,
IDictionary\< string, string > options = null )
inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
list An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is JSON.
options Optional parameters.
  • 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, ALLOW\_PARTIAL\_BATCH, and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • 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 ALLOW\_PARTIAL\_BATCH and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • PK\_CONFLICT\_PREDICATE\_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • PK\_CONFLICT\_PREDICATE\_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • RETURN\_RECORD\_IDS: If TRUE then return the internal record id along for each inserted record. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is FALSE.
  • RETURN\_INDIVIDUAL\_ERRORS: If set to TRUE, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is FALSE.
  • ALLOW\_PARTIAL\_BATCH: If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is FALSE.
  • DRY\_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values: The default value is FALSE.
  • REQUEST\_SCHEMA\_STR: Type schema of list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
  • 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 1017 of file InsertRecords.cs.

◆ RawInsertRecordsRequest() \[3/6]

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( string table\_name,
IList\< byte\[]> list,
IList\< string > list\_str,
string list\_encoding = null,
IDictionary\< string, string > options = null )
inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
list An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is JSON.
list\_str An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is BINARY.
list\_encoding The encoding of the records to be inserted. Supported values: The default value is BINARY.
options Optional parameters.
  • 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, ALLOW\_PARTIAL\_BATCH, and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • 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 ALLOW\_PARTIAL\_BATCH and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • PK\_CONFLICT\_PREDICATE\_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • PK\_CONFLICT\_PREDICATE\_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • RETURN\_RECORD\_IDS: If TRUE then return the internal record id along for each inserted record. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is FALSE.
  • RETURN\_INDIVIDUAL\_ERRORS: If set to TRUE, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is FALSE.
  • ALLOW\_PARTIAL\_BATCH: If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is FALSE.
  • DRY\_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values: The default value is FALSE.
  • REQUEST\_SCHEMA\_STR: Type schema of list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
  • 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 1369 of file InsertRecords.cs.

◆ RawInsertRecordsRequest() \[4/6]

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( )
inline

Constructs a RawInsertRecordsRequest object with default parameters.

Definition at line 696 of file InsertRecords.cs.

◆ RawInsertRecordsRequest() \[5/6]

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( string table\_name,
IList\< byte\[]> list,
IDictionary\< string, string > options = null )
inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
list An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is JSON.
options Optional parameters.
  • 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, ALLOW\_PARTIAL\_BATCH, and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • 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 ALLOW\_PARTIAL\_BATCH and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • PK\_CONFLICT\_PREDICATE\_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • PK\_CONFLICT\_PREDICATE\_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • RETURN\_RECORD\_IDS: If TRUE then return the internal record id along for each inserted record. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is FALSE.
  • RETURN\_INDIVIDUAL\_ERRORS: If set to TRUE, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is FALSE.
  • ALLOW\_PARTIAL\_BATCH: If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is FALSE.
  • DRY\_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values: The default value is FALSE.
  • REQUEST\_SCHEMA\_STR: Type schema of list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
  • 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 1017 of file InsertRecords.cs.

◆ RawInsertRecordsRequest() \[6/6]

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( string table\_name,
IList\< byte\[]> list,
IList\< string > list\_str,
string list\_encoding = null,
IDictionary\< string, string > options = null )
inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
list An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is JSON.
list\_str An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is BINARY.
list\_encoding The encoding of the records to be inserted. Supported values: The default value is BINARY.
options Optional parameters.
  • 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, ALLOW\_PARTIAL\_BATCH, and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • 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 ALLOW\_PARTIAL\_BATCH and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • PK\_CONFLICT\_PREDICATE\_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • PK\_CONFLICT\_PREDICATE\_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • RETURN\_RECORD\_IDS: If TRUE then return the internal record id along for each inserted record. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is FALSE.
  • RETURN\_INDIVIDUAL\_ERRORS: If set to TRUE, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is FALSE.
  • ALLOW\_PARTIAL\_BATCH: If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is FALSE.
  • DRY\_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values: The default value is FALSE.
  • REQUEST\_SCHEMA\_STR: Type schema of list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
  • 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 1369 of file InsertRecords.cs.

Property Documentation

◆ list

IList\< byte\[]> kinetica.RawInsertRecordsRequest.list = new List\()
getset

An array of binary-encoded data for the records to be added.

All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is JSON.

Definition at line 355 of file InsertRecords.cs.

◆ list\_encoding

string kinetica.RawInsertRecordsRequest.list\_encoding = ListEncoding.BINARY
getset

The encoding of the records to be inserted.

Supported values:

The default value is BINARY.

Definition at line 383 of file InsertRecords.cs.

◆ list\_str

IList\< string > kinetica.RawInsertRecordsRequest.list\_str = new List\()
getset

An array of JSON encoded data for the records to be added.

All records must be of the same type as that of the table. Empty array if RawInsertRecordsRequest.list\_encoding is BINARY.

Definition at line 364 of file InsertRecords.cs.

◆ options

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

Optional parameters.

  • 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, ALLOW\_PARTIAL\_BATCH, and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • ENABLE\_INPLACE\_UPDATES: Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • 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 ALLOW\_PARTIAL\_BATCH and RETURN\_INDIVIDUAL\_ERRORS. 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.
  • PK\_CONFLICT\_PREDICATE\_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • PK\_CONFLICT\_PREDICATE\_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • RETURN\_RECORD\_IDS: If TRUE then return the internal record id along for each inserted record. Supported values: The default value is FALSE.
  • TRUNCATE\_STRINGS: If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is FALSE.
  • RETURN\_INDIVIDUAL\_ERRORS: If set to TRUE, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is FALSE.
  • ALLOW\_PARTIAL\_BATCH: If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is FALSE.
  • DRY\_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values: The default value is FALSE.
  • REQUEST\_SCHEMA\_STR: Type schema of RawInsertRecordsRequest.list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
  • 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 692 of file InsertRecords.cs.

◆ table\_name

string kinetica.RawInsertRecordsRequest.table\_name
getset

Name of table to which the records are to be added, in \[schema\_name.

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

Must be an existing table.

Definition at line 347 of file InsertRecords.cs.

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