A set of parameters for Kinetica.insertRecords. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter RawInsertRecordsRequest.options. More… | |
Public Member Functions | |
| InsertRecordsRequest () | |
| Constructs an InsertRecordsRequest object with default parameters. | |
| InsertRecordsRequest (string table_name, IList< T > data, IDictionary< string, string > options=null) | |
| Constructs an InsertRecordsRequest object with the specified parameters. | |
| InsertRecordsRequest () | |
| Constructs an InsertRecordsRequest object with default parameters. | |
| InsertRecordsRequest (string table_name, IList< T > data, IDictionary< string, string > options=null) | |
| Constructs an InsertRecordsRequest 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. | |
Static Public Attributes | |
| const string | UPDATE_ON_EXISTING_PK = “update_on_existing_pk” |
| Specifies the record collision policy for inserting into a table with a primary key. | |
| const string | TRUE = “true” |
| A boolean constant for the RawInsertRecordsRequest.Options options. | |
| const string | FALSE = “false” |
| A boolean constant for the RawInsertRecordsRequest.Options options. | |
| const string | ENABLE_INPLACE_UPDATES = “enable_inplace_updates” |
| Applies only when upserting (when UPDATE_ON_EXISTING_PK is TRUE). | |
| const string | IGNORE_EXISTING_PK = “ignore_existing_pk” |
| Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE). | |
| const string | PK_CONFLICT_PREDICATE_HIGHER = “pk_conflict_predicate_higher” |
| The record with higher value for the column resolves the primary-key insert conflict. | |
| const string | PK_CONFLICT_PREDICATE_LOWER = “pk_conflict_predicate_lower” |
| The record with lower value for the column resolves the primary-key insert conflict. | |
| const string | RETURN_RECORD_IDS = “return_record_ids” |
| If TRUE then return the internal record id along for each inserted record. | |
| const string | TRUNCATE_STRINGS = “truncate_strings” |
| If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. | |
| const string | RETURN_INDIVIDUAL_ERRORS = “return_individual_errors” |
| If set to TRUE, success will always be returned, and any errors found will be included in the info map. | |
| const string | ALLOW_PARTIAL_BATCH = “allow_partial_batch” |
| If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. | |
| const string | DRY_RUN = “dry_run” |
| If set to TRUE, no data will be saved and any errors will be returned. | |
| const string | REQUEST_SCHEMA_STR = “request_schema_str” |
Type schema of RawInsertRecordsRequest.list (when list_encoding is BINARY), in [[“column_name”,“column_type”]] format. | |
| const string | TRANSFORMATIONS = “transformations” |
| Comma-separated expressions, one per target table column. | |
Properties | |
| string | table_name [get, set] |
| Name of table to which the records are to be added, in [schema_name. | |
| IList< T > | data = new List<T>() [get, set] |
| An array of binary-encoded data for the records to be added. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.insertRecords.
Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The RawInsertRecordsRequest.options parameter can be used to customize this function’s behavior.
The UPDATE_ON_EXISTING_PK option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The RETURN_RECORD_IDS option indicates that the database should return the unique identifiers of inserted records.
| T | The type of object being processed. |
Definition at line 1404 of file InsertRecords.cs.
Member Function Documentation
◆ InsertRecordsRequest() [1/4]
| inline |
Constructs an InsertRecordsRequest object with default parameters.
Definition at line 2007 of file InsertRecords.cs.
◆ InsertRecordsRequest() [2/4]
| inline |
Constructs an InsertRecordsRequest object with default parameters.
Definition at line 2007 of file InsertRecords.cs.
◆ InsertRecordsRequest() [3/4]
| inline |
Constructs an InsertRecordsRequest object with the specified parameters.
| table_name | Name of table to which the records are to be added, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| data | An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if list_encoding is JSON. |
| options | Optional parameters.
|
Definition at line 2325 of file InsertRecords.cs.
◆ InsertRecordsRequest() [4/4]
| inline |
Constructs an InsertRecordsRequest object with the specified parameters.
| table_name | Name of table to which the records are to be added, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| data | An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if list_encoding is JSON. |
| options | Optional parameters.
|
Definition at line 2325 of file InsertRecords.cs.
Member Data Documentation
◆ ALLOW_PARTIAL_BATCH
| static |
◆ DRY_RUN
| static |
◆ ENABLE_INPLACE_UPDATES
| static |
Applies only when upserting (when UPDATE_ON_EXISTING_PK is TRUE).
If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is 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 1487 of file InsertRecords.cs.
◆ FALSE
| static |
A boolean constant for the RawInsertRecordsRequest.Options options.
Definition at line 1458 of file InsertRecords.cs.
◆ IGNORE_EXISTING_PK
| static |
Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE).
If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ALLOW_PARTIAL_BATCH and RETURN_INDIVIDUAL_ERRORS. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE_ON_EXISTING_PK is TRUE), then this option has no effect. Supported values:
- TRUE: Ignore new records whose primary key values collide with those of existing records.
- FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
The default value is FALSE.
Definition at line 1535 of file InsertRecords.cs.
◆ PK_CONFLICT_PREDICATE_HIGHER
| static |
The record with higher value for the column resolves the primary-key insert conflict.
The default value is ”.
Definition at line 1540 of file InsertRecords.cs.
◆ PK_CONFLICT_PREDICATE_LOWER
| static |
The record with lower value for the column resolves the primary-key insert conflict.
The default value is ”.
Definition at line 1545 of file InsertRecords.cs.
◆ REQUEST_SCHEMA_STR
| static |
Type schema of RawInsertRecordsRequest.list (when list_encoding is BINARY), in [[“column_name”,“column_type”]] format.
When non-empty and different from the table’s schema, the server remaps the incoming records to the table’s full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table’s full schema. The default value is ”.
Definition at line 1670 of file InsertRecords.cs.
◆ RETURN_INDIVIDUAL_ERRORS
| static |
If set to TRUE, success will always be returned, and any errors found will be included in the info map.
The “bad_record_indices” entry is a comma-separated list of bad records (0-based). If so, there will also be an “error_N” entry for each record with an error, where N is the index (0-based). Supported values:
The default value is FALSE.
Definition at line 1614 of file InsertRecords.cs.
◆ RETURN_RECORD_IDS
| static |
◆ TRANSFORMATIONS
| static |
Comma-separated expressions, one per target table column.
Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position (2 for the second, etc.). The default value is ”.
Definition at line 1680 of file InsertRecords.cs.
◆ TRUE
| static |
A boolean constant for the RawInsertRecordsRequest.Options options.
Definition at line 1454 of file InsertRecords.cs.
◆ TRUNCATE_STRINGS
| static |
◆ UPDATE_ON_EXISTING_PK
| static |
Specifies the record collision policy for inserting into a table with a primary key.
If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be “upserted”). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE_EXISTING_PK, ALLOW_PARTIAL_BATCH, and RETURN_INDIVIDUAL_ERRORS. If the specified table does not have a primary key, then this option has no effect. Supported values:
- TRUE: Upsert new records when primary keys match existing records.
- FALSE: Reject new records when primary keys match existing records.
The default value is FALSE.
Definition at line 1450 of file InsertRecords.cs.
Property Documentation
◆ data
| getset |
An array of binary-encoded data for the records to be added.
All records must be of the same type as that of the table. Empty array if list_encoding is JSON.
Definition at line 1695 of file InsertRecords.cs.
◆ options
| getset |
Optional parameters.
- UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting into a table with a primary key. If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be “upserted”). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE_EXISTING_PK, ALLOW_PARTIAL_BATCH, and RETURN_INDIVIDUAL_ERRORS. If the specified table does not have a primary key, then this option has no effect. Supported values:
- TRUE: Upsert new records when primary keys match existing records.
- FALSE: Reject new records when primary keys match existing records.
- ENABLE_INPLACE_UPDATES: Applies only when upserting (when UPDATE_ON_EXISTING_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is 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.
- IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE). If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ALLOW_PARTIAL_BATCH and RETURN_INDIVIDUAL_ERRORS. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE_ON_EXISTING_PK is TRUE), then this option has no effect. Supported values:
- TRUE: Ignore new records whose primary key values collide with those of existing records.
- FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
- PK_CONFLICT_PREDICATE_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ”.
- PK_CONFLICT_PREDICATE_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ”.
- RETURN_RECORD_IDS: If TRUE then return the internal record id along for each inserted record. Supported values:The default value is FALSE.
- TRUNCATE_STRINGS: If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit. Supported values:The default value is FALSE.
- RETURN_INDIVIDUAL_ERRORS: If set to TRUE, success will always be returned, and any errors found will be included in the info map. The “bad_record_indices” entry is a comma-separated list of bad records (0-based). If so, there will also be an “error_N” entry for each record with an error, where N is the index (0-based). Supported values:The default value is FALSE.
- ALLOW_PARTIAL_BATCH: If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values:The default value is FALSE.
- DRY_RUN: If set to TRUE, no data will be saved and any errors will be returned. Supported values:The default value is FALSE.
- REQUEST_SCHEMA_STR: Type schema of RawInsertRecordsRequest.list (when
list_encodingisBINARY), in [[“column_name”,“column_type”]] format. When non-empty and different from the table’s schema, the server remaps the incoming records to the table’s full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table’s full schema. The default value is ”. - TRANSFORMATIONS: Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position (2 for the second, etc.). The default value is ”.
The default value is an empty Dictionary.
Definition at line 2003 of file InsertRecords.cs.
◆ table_name
| getset |
Name of table to which the records are to be added, in [schema_name.
]table_name format, using standard name resolution rules.
Must be an existing table.
Definition at line 1688 of file InsertRecords.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/InsertRecords.cs
- Kinetica/Protocol/InsertRecords.cs