Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 <member name="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 /insert/records. More...
 
const string RECORD_ID = "record_id"
 ID of a single record to be updated (returned in the call to /insert/records or /get/records/fromcollection). 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. Values: true, false.
  • update_on_existing_pk Can be used to customize behavior when the updated primary key value already exists, as described in /insert/records. Values: true, 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 <member name="options">.

Definition at line 90 of file UpdateRecords.cs.

Member Data Documentation

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. Values: true, false.

Definition at line 107 of file UpdateRecords.cs.

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

Definition at line 109 of file UpdateRecords.cs.

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

An optional global expression to reduce the search space of the predicates listed in <member name="expressions">.

Definition at line 96 of file UpdateRecords.cs.

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

ID of a single record to be updated (returned in the call to /insert/records or /get/records/fromcollection).

Definition at line 120 of file UpdateRecords.cs.

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

Definition at line 108 of file UpdateRecords.cs.

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 /insert/records.

Values: true, false.

Definition at line 115 of file UpdateRecords.cs.

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