Kinetica C# API  Version 6.2.0.1
Public Attributes | List of all members
kinetica.RawUpdateRecordsRequest.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 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.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 . The default value is ''.
  • 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.
  • USE_EXPRESSIONS_IN_NEW_VALUES_MAPS: When set to true, all new values in are considered as expression values. When set to false, all new values in are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. 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).

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

Definition at line 157 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.

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 185 of file UpdateRecords.cs.

◆ FALSE

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

Definition at line 187 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 163 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.insertRecords<T>(string,IList<T>,IDictionary<string, string>) or Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>)).

Definition at line 235 of file UpdateRecords.cs.

◆ TRUE

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

Definition at line 186 of file UpdateRecords.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.RawUpdateRecordsRequest.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 206 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.

When set to false, all new values in new_values_maps are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. Supported values:

The default value is FALSE.

Definition at line 227 of file UpdateRecords.cs.

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