Skip to main content

​
◆ appendRecords() [1/2]

AppendRecordsResponse kinetica.Kinetica.appendRecords (AppendRecordsRequestrequest_)
 inline

Append (or insert) all records from a source table (specified by source_table_name) to a particular target table (specified by table_name).

The field map (specified by field_map) holds the user specified map of target table column names with their mapped source column names.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 15332 of file KineticaFunctions.cs.

​
◆ appendRecords() [2/2]

AppendRecordsResponse kinetica.Kinetica.appendRecords (stringtable_name,
stringsource_table_name,
IDictionary< string, string >field_map,
IDictionary< string, string >options = null )
 inline

Append (or insert) all records from a source table (specified by source_table_name ) to a particular target table (specified by table_name ).

The field map (specified by field_map ) holds the user specified map of target table column names with their mapped source column names.

Parameters
table_nameThe table name for the records to be appended, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
source_table_nameThe source table name to get records from, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table name.
field_mapContains the mapping of column names from the target table (specified by table_name ) as the keys, and corresponding column names or expressions (e.g., ‘col_name+1’) from the source table (specified by source_table_name ). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
optionsOptional parameters.
  • OFFSET: A positive integer indicating the number of initial results to skip from source_table_name . Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is ‘0’.
  • LIMIT: A positive integer indicating the maximum number of results to be returned from source_table_name . Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.
  • EXPRESSION: Filter expression to apply to the source_table_name . The default value is ”.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by source_table_name ), e.g., ‘timestamp asc, x desc’. The ORDER_BY columns do not have to be present in field_map . The default value is ”.
  • ERROR_HANDLING: Specifies how record errors are handled while appending source table records into the target table. Currently this governs primary-key collision behavior: SKIP and PERMISSIVE drop the colliding source records and continue, while ABORT rejects the batch. Explicit UPDATE_ON_EXISTING_PK or IGNORE_EXISTING_PK take precedence over this option. Supported values:
    • PERMISSIVE: Source records that cannot be appended (e.g. a primary-key collision) are skipped and reported; the rest of the batch is appended.
    • SKIP: Source records that cannot be appended are skipped and reported; the rest of the batch is appended.
    • ABORT: A source record that cannot be appended (e.g. a primary-key collision) raises an error. This is the default.
    The default value is ABORT.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by source_table_name ) into a target table (specified by table_name ) with a primary key. If set to TRUE, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an 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: Upsert new records when primary keys match existing records.
    • FALSE: Reject new records when primary keys match existing records.
    The default value is FALSE.
  • 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 source table records (specified by source_table_name ) into a target table (specified by table_name ) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If FALSE, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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 source table records whose primary key values collide with those of target table records.
    • FALSE: Raise an error for any source table record whose primary key values collide with those of a target table record.
    The default value is FALSE.
  • 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 ”.
  • TRUNCATE_STRINGS: If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 15647 of file KineticaFunctions.cs.

​
◆ AppendRecordsAsync() [1/2]

async System.Threading.Tasks.Task< AppendRecordsResponse > kinetica.Kinetica.AppendRecordsAsync (AppendRecordsRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Append (or insert) all records from a source table (specified by source_table_name) to a particular target table (specified by table_name).

(async)

The field map (specified by field_map) holds the user specified map of target table column names with their mapped source column names.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 15356 of file KineticaFunctions.cs.

​
◆ AppendRecordsAsync() [2/2]

async System.Threading.Tasks.Task< AppendRecordsResponse > kinetica.Kinetica.AppendRecordsAsync (stringtable_name,
stringsource_table_name,
IDictionary< string, string >field_map,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Append (or insert) all records from a source table (specified by source_table_name ) to a particular target table (specified by table_name ).

(async)

The field map (specified by field_map ) holds the user specified map of target table column names with their mapped source column names.

Parameters
table_nameThe table name for the records to be appended, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
source_table_nameThe source table name to get records from, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table name.
field_mapContains the mapping of column names from the target table (specified by table_name ) as the keys, and corresponding column names or expressions (e.g., ‘col_name+1’) from the source table (specified by source_table_name ). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
optionsOptional parameters.
  • OFFSET: A positive integer indicating the number of initial results to skip from source_table_name . Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is ‘0’.
  • LIMIT: A positive integer indicating the maximum number of results to be returned from source_table_name . Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.
  • EXPRESSION: Filter expression to apply to the source_table_name . The default value is ”.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by source_table_name ), e.g., ‘timestamp asc, x desc’. The ORDER_BY columns do not have to be present in field_map . The default value is ”.
  • ERROR_HANDLING: Specifies how record errors are handled while appending source table records into the target table. Currently this governs primary-key collision behavior: SKIP and PERMISSIVE drop the colliding source records and continue, while ABORT rejects the batch. Explicit UPDATE_ON_EXISTING_PK or IGNORE_EXISTING_PK take precedence over this option. Supported values:
    • PERMISSIVE: Source records that cannot be appended (e.g. a primary-key collision) are skipped and reported; the rest of the batch is appended.
    • SKIP: Source records that cannot be appended are skipped and reported; the rest of the batch is appended.
    • ABORT: A source record that cannot be appended (e.g. a primary-key collision) raises an error. This is the default.
    The default value is ABORT.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by source_table_name ) into a target table (specified by table_name ) with a primary key. If set to TRUE, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an 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: Upsert new records when primary keys match existing records.
    • FALSE: Reject new records when primary keys match existing records.
    The default value is FALSE.
  • 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 source table records (specified by source_table_name ) into a target table (specified by table_name ) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If FALSE, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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 source table records whose primary key values collide with those of target table records.
    • FALSE: Raise an error for any source table record whose primary key values collide with those of a target table record.
    The default value is FALSE.
  • 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 ”.
  • TRUNCATE_STRINGS: If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 15941 of file KineticaFunctions.cs.