Kinetica C# API  Version 6.1.0.0
kinetica.InsertRecordsRequest< T >.Options Struct Reference

Optional parameters. More...

Public Attributes

const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk"
 Specifies the record collision policy for inserting into a table with a primary key. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string RETURN_RECORD_IDS = "return_record_ids"
 If true then return the internal record id along for each inserted record. More...
 
const string ROUTE_TO_ADDRESS = "route_to_address"
 Route to a specific rank/tom. More...
 

Detailed Description

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. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values: The default value is FALSE.
  • RETURN_RECORD_IDS: If true then return the internal record id along for each inserted record. Supported values: The default value is FALSE.
  • ROUTE_TO_ADDRESS: Route to a specific rank/tom. Option not suitable for tables using primary/shard keys


A set of string constants for the parameter options.

Definition at line 543 of file InsertRecords.cs.

Member Data Documentation

◆ FALSE

const string kinetica.InsertRecordsRequest< T >.Options.FALSE = "false"

Definition at line 572 of file InsertRecords.cs.

◆ RETURN_RECORD_IDS

const string kinetica.InsertRecordsRequest< T >.Options.RETURN_RECORD_IDS = "return_record_ids"

If true then return the internal record id along for each inserted record.

Supported values:

The default value is FALSE.

Definition at line 589 of file InsertRecords.cs.

◆ ROUTE_TO_ADDRESS

const string kinetica.InsertRecordsRequest< T >.Options.ROUTE_TO_ADDRESS = "route_to_address"

Route to a specific rank/tom.

Option not suitable for tables using primary/shard keys

Definition at line 593 of file InsertRecords.cs.

◆ TRUE

const string kinetica.InsertRecordsRequest< T >.Options.TRUE = "true"

Definition at line 571 of file InsertRecords.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.InsertRecordsRequest< T >.Options.UPDATE_ON_EXISTING_PK = "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. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:

The default value is FALSE.

Definition at line 570 of file InsertRecords.cs.


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