Kinetica C# API
Version 7.1.10.0
|
A set of parameters for Kinetica.updateRecords{T}(string,IList{string},IList{IDictionary{string, string}},IList{T},IDictionary{string, string}). More...
Classes | |
struct | Options |
Optional parameters. More... | |
struct | RecordEncoding |
Identifies which of and should be used. More... | |
Public Member Functions | |
RawUpdateRecordsRequest () | |
Constructs a RawUpdateRecordsRequest object with default parameters. More... | |
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. More... | |
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. More... | |
![]() | |
KineticaData (KineticaType type) | |
Constructor from Kinetica Type More... | |
KineticaData (System.Type type=null) | |
Default constructor, with optional System.Type More... | |
object | Get (int fieldPos) |
Retrieve a specific property from this object More... | |
void | Put (int fieldPos, object fieldValue) |
Write a specific property to this object More... | |
Properties | |
string | table_name [get, set] |
Name of table to be updated, in [schema_name. More... | |
IList< string > | expressions [get, set] |
A list of the actual predicates, one for each update; format should follow the guidelines /filter. More... | |
IList< IDictionary< string, string > > | new_values_maps = new List<string>() [get, set] |
List of new values for the matching records. More... | |
IList< byte[]> | records_to_insert = new List<IDictionary<string, string>>() [get, set] |
An optional list of new binary-avro encoded records to insert, one for each update. More... | |
IList< string > | records_to_insert_str = new List<byte[]>() [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. More... | |
string | record_encoding = new List<string>() [get, set] |
Identifies which of and should be used. More... | |
IDictionary< string, string > | options = RecordEncoding.BINARY [get, set] |
Optional parameters. More... | |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
Additional Inherited Members | |
![]() | |
static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.updateRecords{T}(string,IList{string},IList{IDictionary{string, string}},IList{T},IDictionary{string, string}).
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 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 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 59 of file UpdateRecords.cs.
|
inline |
Constructs a RawUpdateRecordsRequest object with default parameters.
Definition at line 771 of file UpdateRecords.cs.
|
inline |
Constructs a RawUpdateRecordsRequest object with the specified 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 /filter. |
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 . |
records_to_insert | An optional list of new binary-avro encoded records to insert, one for each update. If one of 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.
|
Definition at line 1005 of file UpdateRecords.cs.
|
inline |
Constructs a RawUpdateRecordsRequest object with the specified 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 /filter. |
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 . |
records_to_insert | An optional list of new binary-avro encoded records to insert, one for each update. If one of 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 and should be used. Supported values: The default value is BINARY. |
options | Optional parameters.
|
Definition at line 1275 of file UpdateRecords.cs.
|
getset |
A list of the actual predicates, one for each update; format should follow the guidelines /filter.
Definition at line 510 of file UpdateRecords.cs.
|
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 .
Definition at line 519 of file UpdateRecords.cs.
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 766 of file UpdateRecords.cs.
|
getset |
Identifies which of and should be used.
Supported values:
The default value is BINARY.
Definition at line 553 of file UpdateRecords.cs.
|
getset |
An optional list of new binary-avro encoded records to insert, one for each update.
If one of 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 528 of file UpdateRecords.cs.
|
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 533 of file UpdateRecords.cs.
|
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 506 of file UpdateRecords.cs.