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

Optional parameters. 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"
 Can be used to customize behavior when the updated primary key value already exists as described in Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>). More...
 
const string RECORD_ID = "record_id"
 ID of a single record to be updated (returned in the call to Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>) or Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>)). More...
 

Detailed Description

Optional parameters.

  • GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in .
  • BYPASS_SAFETY_CHECKS: When set to 'true', all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values: The default value is FALSE.
  • UPDATE_ON_EXISTING_PK: Can be used to customize behavior when the updated primary key value already exists as described in /insert/records. Supported values: The default value is FALSE.
  • RECORD_ID: ID of a single record to be updated (returned in the call to /insert/records or /get/records/fromcollection).


A set of string constants for the parameter options.

Definition at line 626 of file UpdateRecords.cs.

Member Data Documentation

◆ BYPASS_SAFETY_CHECKS

const string kinetica.UpdateRecordsRequest< T >.Options.BYPASS_SAFETY_CHECKS = "bypass_safety_checks"

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

Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values:

The default value is FALSE.

Definition at line 654 of file UpdateRecords.cs.

◆ FALSE

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

Definition at line 656 of file UpdateRecords.cs.

◆ GLOBAL_EXPRESSION

const string kinetica.UpdateRecordsRequest< T >.Options.GLOBAL_EXPRESSION = "global_expression"

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

Definition at line 632 of file UpdateRecords.cs.

◆ RECORD_ID

const string kinetica.UpdateRecordsRequest< T >.Options.RECORD_ID = "record_id"

◆ TRUE

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

Definition at line 655 of file UpdateRecords.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.UpdateRecordsRequest< T >.Options.UPDATE_ON_EXISTING_PK = "update_on_existing_pk"

Can be used to customize behavior when the updated primary key value already exists as described in Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>).

Supported values:

The default value is FALSE.

Definition at line 675 of file UpdateRecords.cs.


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