Kinetica C# API  Version 6.2.0.1
kinetica.AppendRecordsRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string OFFSET = "offset"
 A positive integer indicating the number of initial results to skip from source table (specified by source_table_name). More...
 
const string LIMIT = "limit"
 A positive integer indicating the maximum number of results to be returned from source table (specified by source_table_name). More...
 
const string EXPRESSION = "expression"
 Optional filter expression to apply to the source table (specified by source_table_name). More...
 
const string ORDER_BY = "order_by"
 Comma-separated list of the columns and expressions to be sorted by from the source table (specified by source_table_name); e.g. More...
 
const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk"
 Specifies the record collision policy for inserting the source table records (specified by source_table_name) into the target table (specified by table_name) table with a primary key. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string TRUNCATE_STRINGS = "truncate_strings"
 If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. More...
 

Detailed Description

Optional parameters.

  • OFFSET: A positive integer indicating the number of initial results to skip from source table (specified by ). 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 (specified by ). Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
  • EXPRESSION: Optional filter expression to apply to the source table (specified by ). Empty by default. The default value is ''.
  • ORDER_BY: Comma-separated list of the columns and expressions to be sorted by from the source table (specified by ); e.g. 'timestamp asc, x desc'. The order_by columns do not have to be present in . The default value is ''.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting the source table records (specified by ) into the target table (specified by ) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values: The default value is FALSE.
  • TRUNCATE_STRINGS: If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. Supported values: The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 119 of file AppendRecords.cs.

Member Data Documentation

◆ EXPRESSION

const string kinetica.AppendRecordsRequest.Options.EXPRESSION = "expression"

Optional filter expression to apply to the source table (specified by source_table_name).

Empty by default. The default value is ''.

Definition at line 139 of file AppendRecords.cs.

◆ FALSE

const string kinetica.AppendRecordsRequest.Options.FALSE = "false"

Definition at line 176 of file AppendRecords.cs.

◆ LIMIT

const string kinetica.AppendRecordsRequest.Options.LIMIT = "limit"

A positive integer indicating the maximum number of results to be returned from source table (specified by 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 134 of file AppendRecords.cs.

◆ OFFSET

const string kinetica.AppendRecordsRequest.Options.OFFSET = "offset"

A positive integer indicating the number of initial results to skip from source table (specified by 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 127 of file AppendRecords.cs.

◆ ORDER_BY

const string kinetica.AppendRecordsRequest.Options.ORDER_BY = "order_by"

Comma-separated list of the columns and expressions to be sorted by from the 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 146 of file AppendRecords.cs.

◆ TRUE

const string kinetica.AppendRecordsRequest.Options.TRUE = "true"

Definition at line 175 of file AppendRecords.cs.

◆ TRUNCATE_STRINGS

const string kinetica.AppendRecordsRequest.Options.TRUNCATE_STRINGS = "truncate_strings"

If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit.

Supported values:

The default value is FALSE.

Definition at line 194 of file AppendRecords.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.AppendRecordsRequest.Options.UPDATE_ON_EXISTING_PK = "update_on_existing_pk"

Specifies the record collision policy for inserting the source table records (specified by source_table_name) into the target table (specified by table_name) table with a primary key.

If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:

The default value is FALSE.

Definition at line 174 of file AppendRecords.cs.


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