Kinetica C# API  Version 7.1.10.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 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

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: 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 251 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 403 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 420 of file InsertRecords.cs.

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

Definition at line 289 of file InsertRecords.cs.

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

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.

Definition at line 329 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 384 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 346 of file InsertRecords.cs.

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

Definition at line 288 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 363 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 (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.

Definition at line 287 of file InsertRecords.cs.

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