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 to be sorted from source table (specified by source_table_name) by; 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"

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.
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.
EXPRESSION: Optional filter expression to apply to the source table (specified by ). Empty by default.
ORDER_BY: Comma-separated list of the columns to be sorted from source table (specified by ) by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.
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:
- TRUE
- FALSE
The default value is FALSE.

A set of string constants for the parameter options.

Definition at line 100 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.

Definition at line 118 of file AppendRecords.cs.

◆ FALSE

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

Definition at line 156 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.

Definition at line 113 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.

Definition at line 107 of file AppendRecords.cs.

◆ ORDER_BY

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

Comma-separated list of the columns to be sorted from source table (specified by source_table_name) by; e.g.

'timestamp asc, x desc'. The columns specified must be present in field_map. If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 126 of file AppendRecords.cs.

◆ TRUE

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

Definition at line 155 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:

TRUE
FALSE

The default value is FALSE.

Definition at line 154 of file AppendRecords.cs.

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

Kinetica/Protocol/AppendRecords.cs

Public Attributes