> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.RawUpdateRecordsRequest > kinetica.RawUpdateRecordsRequest — Kinetica C# API

A set of parameters for Kinetica.updateRecordsRaw. More...

Inheritance diagram for kinetica.RawUpdateRecordsRequest:
Collaboration diagram for kinetica.RawUpdateRecordsRequest:

Classes
struct   Options
  A set of string constants for the parameter RawUpdateRecordsRequest.options. More...
 
struct   RecordEncoding
  A set of string constants for the parameter RawUpdateRecordsRequest.record\_encoding. More...
 

Public Member Functions
  RawUpdateRecordsRequest ()
  Constructs a RawUpdateRecordsRequest object with default parameters.
 
  RawUpdateRecordsRequest (string table\_name, IList\< string > expressions, IList\< IDictionary\< string, string > > new\_values\_maps, IList\< byte\[]> records\_to\_insert=null, IDictionary\< string, string > options=null)
  Constructs a RawUpdateRecordsRequest object with the specified parameters.
 
  RawUpdateRecordsRequest (string table\_name, IList\< string > expressions, IList\< IDictionary\< string, string > > new\_values\_maps, IList\< byte\[]> records\_to\_insert=null, IList\< string > records\_to\_insert\_str=null, string record\_encoding=null, IDictionary\< string, string > options=null)
  Constructs a RawUpdateRecordsRequest object with the specified parameters.
 
  RawUpdateRecordsRequest ()
  Constructs a RawUpdateRecordsRequest object with default parameters.
 
  RawUpdateRecordsRequest (string table\_name, IList\< string > expressions, IList\< IDictionary\< string, string > > new\_values\_maps, IList\< byte\[]> records\_to\_insert=null, IDictionary\< string, string > options=null)
  Constructs a RawUpdateRecordsRequest object with the specified parameters.
 
  RawUpdateRecordsRequest (string table\_name, IList\< string > expressions, IList\< IDictionary\< string, string > > new\_values\_maps, IList\< byte\[]> records\_to\_insert=null, IList\< string > records\_to\_insert\_str=null, string record\_encoding=null, IDictionary\< string, string > options=null)
  Constructs a RawUpdateRecordsRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of table to be updated, in \[schema\_name.
 
IList\< string >  expressions = new List\() \[get, set]
  A list of the actual predicates, one for each update; format should follow the guidelines here.
 
IList\< IDictionary\< string, string > >  new\_values\_maps = new List\>() \[get, set]
  List of new values for the matching records.
 
IList\< byte\[]>  records\_to\_insert = new List\() \[get, set]
  An optional list of new binary-avro encoded records to insert, one for each update.
 
IList\< string >  records\_to\_insert\_str = new List\() \[get, set]
  An optional list of JSON encoded objects to insert, one for each update, to be added if the particular update did not match any objects.
 
string  record\_encoding = RecordEncoding.BINARY \[get, set]
  Identifies which of RawUpdateRecordsRequest.records\_to\_insert and RawUpdateRecordsRequest.records\_to\_insert\_str should be used.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.updateRecordsRaw.

Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record's column values will be updated as provided in RawUpdateRecordsRequest.new\_values\_maps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through RawUpdateRecordsRequest.options.

The UPDATE\_ON\_EXISTING\_PK option specifies the record primary key collision policy for tables with a primary key, while IGNORE\_EXISTING\_PK specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

Definition at line 42 of file UpdateRecords.cs.

Constructor & Destructor Documentation

◆ RawUpdateRecordsRequest() \[1/6]

kinetica.RawUpdateRecordsRequest.RawUpdateRecordsRequest ( )
inline

Constructs a RawUpdateRecordsRequest object with default parameters.

Definition at line 669 of file UpdateRecords.cs.

◆ RawUpdateRecordsRequest() \[2/6]

kinetica.RawUpdateRecordsRequest.RawUpdateRecordsRequest ( string table\_name,
IList\< string > expressions,
IList\< IDictionary\< string, string > > new\_values\_maps,
IList\< byte\[]> records\_to\_insert = null,
IDictionary\< string, string > options = null )
inline

Constructs a RawUpdateRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table and not a view.
expressions A list of the actual predicates, one for each update; format should follow the guidelines here.
new\_values\_maps List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions .
records\_to\_insert An optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.
options Optional parameters.
  • GLOBAL\_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions . 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 expressions finds no records to update, and the alternate insert record given in 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 new\_values\_maps taking its place; "insert collisions" will result in the collided-into record being updated with the values in 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.
  • 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.
  • ENABLE\_INPLACE\_UPDATES: 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.
  • 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 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.
  • RECORD\_ID: ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).
The default value is an empty Dictionary.

Definition at line 962 of file UpdateRecords.cs.

◆ RawUpdateRecordsRequest() \[3/6]

kinetica.RawUpdateRecordsRequest.RawUpdateRecordsRequest ( string table\_name,
IList\< string > expressions,
IList\< IDictionary\< string, string > > new\_values\_maps,
IList\< byte\[]> records\_to\_insert = null,
IList\< string > records\_to\_insert\_str = null,
string record\_encoding = null,
IDictionary\< string, string > options = null )
inline

Constructs a RawUpdateRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table and not a view.
expressions A list of the actual predicates, one for each update; format should follow the guidelines here.
new\_values\_maps List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions .
records\_to\_insert An optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.
records\_to\_insert\_str An optional list of JSON encoded objects to insert, one for each update, to be added if the particular update did not match any objects. The default value is an empty List.
record\_encoding Identifies which of records\_to\_insert and RawUpdateRecordsRequest.records\_to\_insert\_str should be used. Supported values: The default value is BINARY.
options Optional parameters.
  • GLOBAL\_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions . 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 expressions finds no records to update, and the alternate insert record given in 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 new\_values\_maps taking its place; "insert collisions" will result in the collided-into record being updated with the values in 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.
  • 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.
  • ENABLE\_INPLACE\_UPDATES: 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.
  • 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 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.
  • RECORD\_ID: ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).
The default value is an empty Dictionary.

Definition at line 1291 of file UpdateRecords.cs.

◆ RawUpdateRecordsRequest() \[4/6]

kinetica.RawUpdateRecordsRequest.RawUpdateRecordsRequest ( )
inline

Constructs a RawUpdateRecordsRequest object with default parameters.

Definition at line 669 of file UpdateRecords.cs.

◆ RawUpdateRecordsRequest() \[5/6]

kinetica.RawUpdateRecordsRequest.RawUpdateRecordsRequest ( string table\_name,
IList\< string > expressions,
IList\< IDictionary\< string, string > > new\_values\_maps,
IList\< byte\[]> records\_to\_insert = null,
IDictionary\< string, string > options = null )
inline

Constructs a RawUpdateRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table and not a view.
expressions A list of the actual predicates, one for each update; format should follow the guidelines here.
new\_values\_maps List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions .
records\_to\_insert An optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.
options Optional parameters.
  • GLOBAL\_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions . 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 expressions finds no records to update, and the alternate insert record given in 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 new\_values\_maps taking its place; "insert collisions" will result in the collided-into record being updated with the values in 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.
  • 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.
  • ENABLE\_INPLACE\_UPDATES: 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.
  • 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 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.
  • RECORD\_ID: ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).
The default value is an empty Dictionary.

Definition at line 962 of file UpdateRecords.cs.

◆ RawUpdateRecordsRequest() \[6/6]

kinetica.RawUpdateRecordsRequest.RawUpdateRecordsRequest ( string table\_name,
IList\< string > expressions,
IList\< IDictionary\< string, string > > new\_values\_maps,
IList\< byte\[]> records\_to\_insert = null,
IList\< string > records\_to\_insert\_str = null,
string record\_encoding = null,
IDictionary\< string, string > options = null )
inline

Constructs a RawUpdateRecordsRequest object with the specified parameters.

Parameters
table\_name Name of table to be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table and not a view.
expressions A list of the actual predicates, one for each update; format should follow the guidelines here.
new\_values\_maps List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions .
records\_to\_insert An optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.
records\_to\_insert\_str An optional list of JSON encoded objects to insert, one for each update, to be added if the particular update did not match any objects. The default value is an empty List.
record\_encoding Identifies which of records\_to\_insert and RawUpdateRecordsRequest.records\_to\_insert\_str should be used. Supported values: The default value is BINARY.
options Optional parameters.
  • GLOBAL\_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions . 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 expressions finds no records to update, and the alternate insert record given in 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 new\_values\_maps taking its place; "insert collisions" will result in the collided-into record being updated with the values in 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.
  • 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.
  • ENABLE\_INPLACE\_UPDATES: 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.
  • 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 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.
  • RECORD\_ID: ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).
The default value is an empty Dictionary.

Definition at line 1291 of file UpdateRecords.cs.

Property Documentation

◆ expressions

IList\< string > kinetica.RawUpdateRecordsRequest.expressions = new List\()
getset

A list of the actual predicates, one for each update; format should follow the guidelines here.

Definition at line 344 of file UpdateRecords.cs.

◆ new\_values\_maps

IList\< IDictionary\< string, string > > kinetica.RawUpdateRecordsRequest.new\_values\_maps = new List\>()
getset

List of new values for the matching records.

Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of RawUpdateRecordsRequest.expressions.

Definition at line 352 of file UpdateRecords.cs.

◆ options

IDictionary\< string, string > kinetica.RawUpdateRecordsRequest.options = new Dictionary\()
getset

Optional parameters.

  • GLOBAL\_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in RawUpdateRecordsRequest.expressions. 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 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.
  • 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.
  • ENABLE\_INPLACE\_UPDATES: 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.
  • 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 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.
  • RECORD\_ID: ID of a single record to be updated (returned in the call to Kinetica.insertRecordsRaw or Kinetica.getRecordsFromCollection).

The default value is an empty Dictionary.

Definition at line 665 of file UpdateRecords.cs.

◆ record\_encoding

string kinetica.RawUpdateRecordsRequest.record\_encoding = RecordEncoding.BINARY
getset

Identifies which of RawUpdateRecordsRequest.records\_to\_insert and RawUpdateRecordsRequest.records\_to\_insert\_str should be used.

Supported values:

The default value is BINARY.

Definition at line 389 of file UpdateRecords.cs.

◆ records\_to\_insert

IList\< byte\[]> kinetica.RawUpdateRecordsRequest.records\_to\_insert = new List\()
getset

An optional list of new binary-avro encoded records to insert, one for each update.

If one of RawUpdateRecordsRequest.expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.

Definition at line 361 of file UpdateRecords.cs.

◆ records\_to\_insert\_str

IList\< string > kinetica.RawUpdateRecordsRequest.records\_to\_insert\_str = new List\()
getset

An optional list of JSON encoded objects to insert, one for each update, to be added if the particular update did not match any objects.

The default value is an empty List.

Definition at line 367 of file UpdateRecords.cs.

◆ table\_name

string kinetica.RawUpdateRecordsRequest.table\_name
getset

Name of table to be updated, in \[schema\_name.

]table\_name format, using standard name resolution rules.

Must be a currently existing table and not a view.

Definition at line 339 of file UpdateRecords.cs.

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