Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.RawInsertRecordsRequest.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 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

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.
  • 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). 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: 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.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 195 of file InsertRecords.cs.

Member Data Documentation

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.

Otherwise, the entire batch will be rejected if any records are incorrect. Supported values:

The default value is FALSE.

Definition at line 298 of file InsertRecords.cs.

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 315 of file InsertRecords.cs.

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

Definition at line 224 of file InsertRecords.cs.

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.

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:

The default value is FALSE.

Definition at line 279 of file InsertRecords.cs.

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 241 of file InsertRecords.cs.

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

Definition at line 223 of file InsertRecords.cs.

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 258 of file InsertRecords.cs.

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.

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 222 of file InsertRecords.cs.

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