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

Inheritance diagram for kinetica.InsertRecordsRequest< T >:

Collaboration diagram for kinetica.InsertRecordsRequest< T >:

Classes
struct	Options
	A set of string constants for the parameter options. More...

Public Member Functions
	InsertRecordsRequest ()
	Constructs an InsertRecordsRequest object with default parameters. More...

	InsertRecordsRequest (string table_name, IList< T > data, IDictionary< string, string > options=null)
	Constructs an InsertRecordsRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of table to which the records are to be added, in [schema_name. More...

IList< T >	data = new List<T>() `[get, set]`
	An array of binary-encoded data for the records to be added. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

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

Detailed Description

A set of parameters for Kinetica.insertRecords.

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

Template Parameters

T	The type of object being processed.

Definition at line 868 of file InsertRecords.cs.

Constructor & Destructor Documentation

◆ InsertRecordsRequest() [1/2]

kinetica.InsertRecordsRequest< T >.InsertRecordsRequest ( )

inline

Constructs an InsertRecordsRequest object with default parameters.

Definition at line 1205 of file InsertRecords.cs.

◆ InsertRecordsRequest() [2/2]

kinetica.InsertRecordsRequest< T >.InsertRecordsRequest	(	string	table_name,
		IList< T >	data,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an InsertRecordsRequest 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.
data	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 `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, & 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. 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 & 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. RETURN_RECORD_IDS: If TRUE then return the internal record id along for each inserted record. Supported values: TRUE FALSE 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: TRUE FALSE 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). And 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: TRUE FALSE 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: TRUE FALSE The default value is FALSE. DRY_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 1401 of file InsertRecords.cs.

Property Documentation

◆ data

IList<T> kinetica.InsertRecordsRequest< T >.data = new List<T>()

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 list_encoding is JSON.

Definition at line 1016 of file InsertRecords.cs.

◆ options

IDictionary<string, string> kinetica.InsertRecordsRequest< T >.options = new Dictionary<string, string>()

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, & 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.
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 & 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.
RETURN_RECORD_IDS: If TRUE then return the internal record id along for each inserted record. Supported values:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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). And 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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is FALSE.
DRY_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 1201 of file InsertRecords.cs.

◆ table_name

string kinetica.InsertRecordsRequest< T >.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 1009 of file InsertRecords.cs.

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

Kinetica/Protocol/InsertRecords.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InsertRecordsRequest() [1/2]

◆ InsertRecordsRequest() [2/2]

Property Documentation

◆ data

◆ options

◆ table_name