Kinetica   C#   API  Version 7.2.3.1
Public Attributes | List of all members
AppendRecordsRequest.Options Struct Reference

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

Public Attributes

const string OFFSET = "offset"
 A positive integer indicating the number of initial results to skip from source_table_name. More...
 
const string LIMIT = "limit"
 A positive integer indicating the maximum number of results to be returned from source_table_name. More...
 
const string EXPRESSION = "expression"
 Filter expression to apply to the source_table_name. More...
 
const string ORDER_BY = "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'. More...
 
const string UPDATE_ON_EXISTING_PK = "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. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string IGNORE_EXISTING_PK = "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). More...
 
const string PK_CONFLICT_PREDICATE_HIGHER = "pk_conflict_predicate_higher"
 The record with higher value for the column resolves the primary-key insert conflict. More...
 
const string PK_CONFLICT_PREDICATE_LOWER = "pk_conflict_predicate_lower"
 The record with lower value for the column resolves the primary-key insert conflict. More...
 
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. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 24 of file AppendRecords.cs.

Member Data Documentation

◆ EXPRESSION

const string AppendRecordsRequest.Options.EXPRESSION = "expression"

Filter expression to apply to the source_table_name.

The default value is ''.

Definition at line 44 of file AppendRecords.cs.

◆ FALSE

const string AppendRecordsRequest.Options.FALSE = "false"

Definition at line 77 of file AppendRecords.cs.

◆ IGNORE_EXISTING_PK

const string AppendRecordsRequest.Options.IGNORE_EXISTING_PK = "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).

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 105 of file AppendRecords.cs.

◆ LIMIT

const string AppendRecordsRequest.Options.LIMIT = "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'.

Definition at line 39 of file AppendRecords.cs.

◆ OFFSET

const string AppendRecordsRequest.Options.OFFSET = "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'.

Definition at line 31 of file AppendRecords.cs.

◆ ORDER_BY

const string AppendRecordsRequest.Options.ORDER_BY = "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 ''.

Definition at line 52 of file AppendRecords.cs.

◆ PK_CONFLICT_PREDICATE_HIGHER

const string AppendRecordsRequest.Options.PK_CONFLICT_PREDICATE_HIGHER = "pk_conflict_predicate_higher"

The record with higher value for the column resolves the primary-key insert conflict.

The default value is ''.

Definition at line 110 of file AppendRecords.cs.

◆ PK_CONFLICT_PREDICATE_LOWER

const string AppendRecordsRequest.Options.PK_CONFLICT_PREDICATE_LOWER = "pk_conflict_predicate_lower"

The record with lower value for the column resolves the primary-key insert conflict.

The default value is ''.

Definition at line 115 of file AppendRecords.cs.

◆ TRUE

const string AppendRecordsRequest.Options.TRUE = "true"

Definition at line 76 of file AppendRecords.cs.

◆ TRUNCATE_STRINGS

const string AppendRecordsRequest.Options.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.

Supported values:

The default value is FALSE.

Definition at line 131 of file AppendRecords.cs.

◆ UPDATE_ON_EXISTING_PK

const string AppendRecordsRequest.Options.UPDATE_ON_EXISTING_PK = "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.

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 74 of file AppendRecords.cs.

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