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

A set of string constants for the parameter options. More...

Public Attributes

const string GLOBAL_EXPRESSION = "global_expression"
 An optional global expression to reduce the search space of the predicates listed in expressions. More...
 
const string BYPASS_SAFETY_CHECKS = "bypass_safety_checks"
 When set to TRUE, all predicates are available for primary key updates. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk"
 Specifies the record collision policy for updating a table with a primary key. More...
 
const string IGNORE_EXISTING_PK = "ignore_existing_pk"
 Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (UPDATE_ON_EXISTING_PK is FALSE). More...
 
const string UPDATE_PARTITION = "update_partition"
 Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. More...
 
const string TRUNCATE_STRINGS = "truncate_strings"
 If set to TRUE, any strings which are too long for their charN string fields will be truncated to fit. More...
 
const string USE_EXPRESSIONS_IN_NEW_VALUES_MAPS = "use_expressions_in_new_values_maps"
 When set to TRUE, all new values in new_values_maps are considered as expression values. More...
 
const string RECORD_ID = "record_id"
 ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection). More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 75 of file UpdateRecords.cs.

Member Data Documentation

◆ BYPASS_SAFETY_CHECKS

const string kinetica.RawUpdateRecordsRequest.Options.BYPASS_SAFETY_CHECKS = "bypass_safety_checks"

When set to TRUE, all predicates are available for primary key updates.

Supported values:

The default value is FALSE.

Definition at line 96 of file UpdateRecords.cs.

◆ FALSE

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

Definition at line 99 of file UpdateRecords.cs.

◆ GLOBAL_EXPRESSION

const string kinetica.RawUpdateRecordsRequest.Options.GLOBAL_EXPRESSION = "global_expression"

An optional global expression to reduce the search space of the predicates listed in expressions.

The default value is ''.

Definition at line 81 of file UpdateRecords.cs.

◆ IGNORE_EXISTING_PK

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

Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (UPDATE_ON_EXISTING_PK is FALSE).

Supported values:

  • TRUE: Ignore updates that result in primary key collisions with existing records
  • FALSE: Treat as errors any updates that result in primary key collisions with existing records

The default value is FALSE.

Definition at line 148 of file UpdateRecords.cs.

◆ RECORD_ID

const string kinetica.RawUpdateRecordsRequest.Options.RECORD_ID = "record_id"

ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).

Definition at line 203 of file UpdateRecords.cs.

◆ TRUE

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

Definition at line 98 of file UpdateRecords.cs.

◆ TRUNCATE_STRINGS

const string kinetica.RawUpdateRecordsRequest.Options.TRUNCATE_STRINGS = "truncate_strings"

If set to TRUE, any strings which are too long for their charN string fields will be truncated to fit.

Supported values:

The default value is FALSE.

Definition at line 179 of file UpdateRecords.cs.

◆ UPDATE_ON_EXISTING_PK

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

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

Supported values:

  • TRUE: Overwrite the collided-into record when updating a record's primary key or inserting an alternate record causes a primary key collision between the record being updated/inserted and another existing record in the table
  • FALSE: Reject updates which cause primary key collisions between the record being updated/inserted and an existing record in the table

The default value is FALSE.

Definition at line 123 of file UpdateRecords.cs.

◆ UPDATE_PARTITION

const string kinetica.RawUpdateRecordsRequest.Options.UPDATE_PARTITION = "update_partition"

Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated.

Supported values:

The default value is FALSE.

Definition at line 163 of file UpdateRecords.cs.

◆ USE_EXPRESSIONS_IN_NEW_VALUES_MAPS

const string kinetica.RawUpdateRecordsRequest.Options.USE_EXPRESSIONS_IN_NEW_VALUES_MAPS = "use_expressions_in_new_values_maps"

When set to TRUE, all new values in new_values_maps are considered as expression values.

Supported values:

The default value is FALSE.

Definition at line 195 of file UpdateRecords.cs.

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