Kinetica C# API  Version 7.0.19.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 tables with a primary key when updating columns of the primary key or inserting new records. 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 tables with a primary key when updating columns of the primary key or inserting new records. If true, existing records with primary key values that match those of a record being updated or inserted will be replaced by the updated and new records. If false, existing records with matching primary key values will remain unchanged, and the updated or new records with primary key values that match those of existing records will be discarded. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • TRUE: Overwrite existing records when updated and inserted records have the same primary keys
    • FALSE: Discard updated and inserted records when the same primary keys already exist
    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 214 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 242 of file UpdateRecords.cs.

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

Definition at line 244 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 220 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 339 of file UpdateRecords.cs.

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

Definition at line 243 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 310 of file UpdateRecords.cs.

const string kinetica.RawUpdateRecordsRequest.Options.UPDATE_ON_EXISTING_PK = "update_on_existing_pk"

Specifies the record collision policy for tables with a primary key when updating columns of the primary key or inserting new records.

If true, existing records with primary key values that match those of a record being updated or inserted will be replaced by the updated and new records. If false, existing records with matching primary key values will remain unchanged, and the updated or new records with primary key values that match those of existing records will be discarded. If the specified table does not have a primary key, then this option has no effect. Supported values:

  • TRUE: Overwrite existing records when updated and inserted records have the same primary keys
  • FALSE: Discard updated and inserted records when the same primary keys already exist

The default value is FALSE.

Definition at line 276 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 293 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 331 of file UpdateRecords.cs.

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