Skip to main content

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

​
Static Public Attributes

const string GLOBAL_EXPRESSION = “global_expression”
 An optional global expression to reduce the search space of the predicates listed in RawUpdateRecordsRequest.expressions.
 
const string BYPASS_SAFETY_CHECKS = “bypass_safety_checks”
 When set to TRUE, all predicates are available for primary key updates.
 
const string TRUE = “true”
 A boolean constant for the RawUpdateRecordsRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the RawUpdateRecordsRequest.Options options.
 
const string UPDATE_ON_EXISTING_PK = “update_on_existing_pk”
 Specifies the record collision policy for updating a table with a primary key.
 
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).
 
const string UPDATE_PARTITION = “update_partition”
 Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated.
 
const string ENABLE_INPLACE_UPDATES = “enable_inplace_updates”
 If set to TRUE, qualifying records are modified in place.
 
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.
 
const string USE_EXPRESSIONS_IN_NEW_VALUES_MAPS = “use_expressions_in_new_values_maps”
 When set to TRUE, all new values in RawUpdateRecordsRequest.new_values_maps are considered as expression values.
 
const string RECORD_ID = “record_id”
 ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).
 

​
Detailed Description

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

Optional parameters.

Definition at line 81 of file UpdateRecords.cs.

​
Member Data Documentation

​
◆ BYPASS_SAFETY_CHECKS

const string kinetica.RawUpdateRecordsRequest.Options.BYPASS_SAFETY_CHECKS = “bypass_safety_checks”
 static

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

​
◆ ENABLE_INPLACE_UPDATES

const string kinetica.RawUpdateRecordsRequest.Options.ENABLE_INPLACE_UPDATES = “enable_inplace_updates”
 static

If set to TRUE, qualifying records are modified in place.

If set to FALSE, they are updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:

The default value is TRUE.

Definition at line 271 of file UpdateRecords.cs.

​
◆ FALSE

const string kinetica.RawUpdateRecordsRequest.Options.FALSE = “false”
 static

A boolean constant for the RawUpdateRecordsRequest.Options options.

Definition at line 122 of file UpdateRecords.cs.

​
◆ GLOBAL_EXPRESSION

const string kinetica.RawUpdateRecordsRequest.Options.GLOBAL_EXPRESSION = “global_expression”
 static

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

The default value is ”.

Definition at line 87 of file UpdateRecords.cs.

​
◆ IGNORE_EXISTING_PK

const string kinetica.RawUpdateRecordsRequest.Options.IGNORE_EXISTING_PK = “ignore_existing_pk”
 static

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

If set to TRUE, any record update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If FALSE, the rejection of any update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if UPDATE_ON_EXISTING_PK is TRUE, then this option has no effect. 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 225 of file UpdateRecords.cs.

​
◆ RECORD_ID

const string kinetica.RawUpdateRecordsRequest.Options.RECORD_ID = “record_id”
 static

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

Definition at line 330 of file UpdateRecords.cs.

​
◆ TRUE

const string kinetica.RawUpdateRecordsRequest.Options.TRUE = “true”
 static

A boolean constant for the RawUpdateRecordsRequest.Options options.

Definition at line 118 of file UpdateRecords.cs.

​
◆ TRUNCATE_STRINGS

const string kinetica.RawUpdateRecordsRequest.Options.TRUNCATE_STRINGS = “truncate_strings”
 static

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

​
◆ UPDATE_ON_EXISTING_PK

const string kinetica.RawUpdateRecordsRequest.Options.UPDATE_ON_EXISTING_PK = “update_on_existing_pk”
 static

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

There are two ways that a record collision can occur.

The first is an “update collision”, which happens when the update changes the value of the updated record’s primary key, and that new primary key already exists as the primary key of another record in the table.

The second is an “insert collision”, which occurs when a given filter in RawUpdateRecordsRequest.expressions finds no records to update, and the alternate insert record given in RawUpdateRecordsRequest.records_to_insert (or RawUpdateRecordsRequest.records_to_insert_str) contains a primary key matching that of an existing record in the table.

If UPDATE_ON_EXISTING_PK is set to TRUE, “update collisions” will result in the existing record collided into being removed and the record updated with values specified in RawUpdateRecordsRequest.new_values_maps taking its place; “insert collisions” will result in the collided-into record being updated with the values in RawUpdateRecordsRequest.records_to_insert / RawUpdateRecordsRequest.records_to_insert_str (if given).

If set to FALSE, the existing collided-into record will remain unchanged, while the update will be rejected and the error handled as determined by IGNORE_EXISTING_PK. If the specified table does not have a primary key, then this option has no effect. 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 183 of file UpdateRecords.cs.

​
◆ UPDATE_PARTITION

const string kinetica.RawUpdateRecordsRequest.Options.UPDATE_PARTITION = “update_partition”
 static

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 245 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”
 static

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

When set to FALSE, all new values in RawUpdateRecordsRequest.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 322 of file UpdateRecords.cs.

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