Kinetica C# API  Version 7.1.10.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 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.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: 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 finds no records to update, and the alternate insert record given in (or ) 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 taking its place; "insert collisions" will result in the collided-into record being updated with the values in / (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.
  • 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). 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.
  • UPDATE_PARTITION: Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. Supported values: The default value is FALSE.
  • 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.
  • 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 301 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. Supported values:

The default value is FALSE.

Definition at line 331 of file UpdateRecords.cs.

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

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

The default value is ''.

Definition at line 307 of file UpdateRecords.cs.

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

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 432 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 Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}) or Kinetica.getRecordsFromCollection{T}(string,long,long,IDictionary{string, string})).

Definition at line 497 of file UpdateRecords.cs.

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

Definition at line 332 of file UpdateRecords.cs.

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

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.

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 expressions finds no records to update, and the alternate insert record given in records_to_insert (or 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 new_values_maps taking its place; "insert collisions" will result in the collided-into record being updated with the values in records_to_insert/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 396 of file UpdateRecords.cs.

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

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

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