Kinetica   C#   API  Version 7.2.3.0
Public Attributes | List of all members
kinetica.RawInsertRecordsRequest.Options Struct Reference

A set of string constants for the parameter options. 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 IGNORE_EXISTING_PK = "ignore_existing_pk"
 Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE). More...
 
const string RETURN_RECORD_IDS = "return_record_ids"
 If TRUE then return the internal record id along for each inserted record. More...
 
const string TRUNCATE_STRINGS = "truncate_strings"
 If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. More...
 
const string RETURN_INDIVIDUAL_ERRORS = "return_individual_errors"
 If set to TRUE, success will always be returned, and any errors found will be included in the info map. More...
 
const string ALLOW_PARTIAL_BATCH = "allow_partial_batch"
 If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. More...
 
const string DRY_RUN = "dry_run"
 If set to TRUE, no data will be saved and any errors will be returned. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 60 of file InsertRecords.cs.

Member Data Documentation

◆ ALLOW_PARTIAL_BATCH

const string kinetica.RawInsertRecordsRequest.Options.ALLOW_PARTIAL_BATCH = "allow_partial_batch"

If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported.

Supported values:

The default value is FALSE.

Definition at line 173 of file InsertRecords.cs.

◆ DRY_RUN

const string kinetica.RawInsertRecordsRequest.Options.DRY_RUN = "dry_run"

If set to TRUE, no data will be saved and any errors will be returned.

Supported values:

The default value is FALSE.

Definition at line 188 of file InsertRecords.cs.

◆ FALSE

const string kinetica.RawInsertRecordsRequest.Options.FALSE = "false"

Definition at line 84 of file InsertRecords.cs.

◆ IGNORE_EXISTING_PK

const string kinetica.RawInsertRecordsRequest.Options.IGNORE_EXISTING_PK = "ignore_existing_pk"

Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE).

Supported values:

  • TRUE: Ignore new records whose primary key values collide with those of existing records
  • FALSE: Treat as errors any new records whose primary key values collide with those of existing records

The default value is FALSE.

Definition at line 110 of file InsertRecords.cs.

◆ RETURN_INDIVIDUAL_ERRORS

const string kinetica.RawInsertRecordsRequest.Options.RETURN_INDIVIDUAL_ERRORS = "return_individual_errors"

If set to TRUE, success will always be returned, and any errors found will be included in the info map.

Supported values:

The default value is FALSE.

Definition at line 157 of file InsertRecords.cs.

◆ RETURN_RECORD_IDS

const string kinetica.RawInsertRecordsRequest.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 125 of file InsertRecords.cs.

◆ TRUE

const string kinetica.RawInsertRecordsRequest.Options.TRUE = "true"

Definition at line 83 of file InsertRecords.cs.

◆ TRUNCATE_STRINGS

const string kinetica.RawInsertRecordsRequest.Options.TRUNCATE_STRINGS = "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.

Definition at line 141 of file InsertRecords.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.RawInsertRecordsRequest.Options.UPDATE_ON_EXISTING_PK = "update_on_existing_pk"

Specifies the record collision policy for inserting into a table with a primary key.

Supported values:

  • TRUE: Upsert new records when primary keys match existing records
  • FALSE: Reject new records when primary keys match existing records

The default value is FALSE.

Definition at line 81 of file InsertRecords.cs.

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