Skip to main content

A set of string constants for the parameter AppendRecordsRequest.options. More…

​
Static Public Attributes

const string OFFSET = “offset”
 A positive integer indicating the number of initial results to skip from AppendRecordsRequest.source_table_name.
 
const string LIMIT = “limit”
 A positive integer indicating the maximum number of results to be returned from AppendRecordsRequest.source_table_name.
 
const string EXPRESSION = “expression”
 Filter expression to apply to the AppendRecordsRequest.source_table_name.
 
const string ORDER_BY = “order_by”
 Comma-separated list of the columns to be sorted by from source table (specified by AppendRecordsRequest.source_table_name), e.g., ‘timestamp asc, x desc’.
 
const string UPDATE_ON_EXISTING_PK = “update_on_existing_pk”
 Specifies the record collision policy for inserting source table records (specified by AppendRecordsRequest.source_table_name) into a target table (specified by AppendRecordsRequest.table_name) with a primary key.
 
const string TRUE = “true”
 A boolean constant for the AppendRecordsRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AppendRecordsRequest.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 source table records (specified by AppendRecordsRequest.source_table_name) into a target table (specified by AppendRecordsRequest.table_name) 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 TRUNCATE_STRINGS = “truncate_strings”
 If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit.
 
const string ERROR_HANDLING = “error_handling”
 Specifies how record errors are handled while appending source table records into the target table.
 
const string PERMISSIVE = “permissive”
 Source records that cannot be appended (e.g.
 
const string SKIP = “skip”
 Source records that cannot be appended are skipped and reported; the rest of the batch is appended.
 
const string ABORT = “abort”
 A source record that cannot be appended (e.g.
 

​
Detailed Description

A set of string constants for the parameter AppendRecordsRequest.options.

Optional parameters.

Definition at line 26 of file AppendRecords.cs.

​
Member Data Documentation

​
◆ ABORT

const string kinetica.AppendRecordsRequest.Options.ABORT = “abort”
 static

A source record that cannot be appended (e.g.

a primary-key collision) raises an error.

This is the default.

Definition at line 116 of file AppendRecords.cs.

​
◆ ENABLE_INPLACE_UPDATES

const string kinetica.AppendRecordsRequest.Options.ENABLE_INPLACE_UPDATES = “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 133 of file AppendRecords.cs.

​
◆ ERROR_HANDLING

const string kinetica.AppendRecordsRequest.Options.ERROR_HANDLING = “error_handling”
 static

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.

Definition at line 102 of file AppendRecords.cs.

​
◆ EXPRESSION

const string kinetica.AppendRecordsRequest.Options.EXPRESSION = “expression”
 static

Filter expression to apply to the AppendRecordsRequest.source_table_name.

The default value is ”.

Definition at line 47 of file AppendRecords.cs.

​
◆ FALSE

const string kinetica.AppendRecordsRequest.Options.FALSE = “false”
 static

A boolean constant for the AppendRecordsRequest.Options options.

Definition at line 105 of file AppendRecords.cs.

​
◆ IGNORE_EXISTING_PK

const string kinetica.AppendRecordsRequest.Options.IGNORE_EXISTING_PK = “ignore_existing_pk”
 static

Specifies the record collision error-suppression policy for inserting source table records (specified by AppendRecordsRequest.source_table_name) into a target table (specified by AppendRecordsRequest.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.

Definition at line 179 of file AppendRecords.cs.

​
◆ LIMIT

const string kinetica.AppendRecordsRequest.Options.LIMIT = “limit”
 static

A positive integer indicating the maximum number of results to be returned from AppendRecordsRequest.source_table_name.

Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.

Definition at line 42 of file AppendRecords.cs.

​
◆ OFFSET

const string kinetica.AppendRecordsRequest.Options.OFFSET = “offset”
 static

A positive integer indicating the number of initial results to skip from AppendRecordsRequest.source_table_name.

Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is ‘0’.

Definition at line 34 of file AppendRecords.cs.

​
◆ ORDER_BY

const string kinetica.AppendRecordsRequest.Options.ORDER_BY = “order_by”
 static

Comma-separated list of the columns to be sorted by from source table (specified by AppendRecordsRequest.source_table_name), e.g., ‘timestamp asc, x desc’.

The ORDER_BY columns do not have to be present in AppendRecordsRequest.field_map. The default value is ”.

Definition at line 58 of file AppendRecords.cs.

​
◆ PERMISSIVE

const string kinetica.AppendRecordsRequest.Options.PERMISSIVE = “permissive”
 static

Source records that cannot be appended (e.g.

a primary-key collision) are skipped and reported; the rest of the batch is appended.

Definition at line 107 of file AppendRecords.cs.

​
◆ PK_CONFLICT_PREDICATE_HIGHER

const string kinetica.AppendRecordsRequest.Options.PK_CONFLICT_PREDICATE_HIGHER = “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 184 of file AppendRecords.cs.

​
◆ PK_CONFLICT_PREDICATE_LOWER

const string kinetica.AppendRecordsRequest.Options.PK_CONFLICT_PREDICATE_LOWER = “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 189 of file AppendRecords.cs.

​
◆ SKIP

const string kinetica.AppendRecordsRequest.Options.SKIP = “skip”
 static

Source records that cannot be appended are skipped and reported; the rest of the batch is appended.

Definition at line 111 of file AppendRecords.cs.

​
◆ TRUE

const string kinetica.AppendRecordsRequest.Options.TRUE = “true”
 static

A boolean constant for the AppendRecordsRequest.Options options.

Definition at line 101 of file AppendRecords.cs.

​
◆ TRUNCATE_STRINGS

const string kinetica.AppendRecordsRequest.Options.TRUNCATE_STRINGS = “truncate_strings”
 static

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.

Definition at line 210 of file AppendRecords.cs.

​
◆ UPDATE_ON_EXISTING_PK

const string kinetica.AppendRecordsRequest.Options.UPDATE_ON_EXISTING_PK = “update_on_existing_pk”
 static

Specifies the record collision policy for inserting source table records (specified by AppendRecordsRequest.source_table_name) into a target table (specified by AppendRecordsRequest.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.

Definition at line 97 of file AppendRecords.cs.

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