Optional parameters. 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"
	Optional 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	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

Optional parameters.

OFFSET: A positive integer indicating the number of initial results to skip from . 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 . 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 . The default value is ''.
ORDER_BY: Comma-separated list of the columns to be sorted by from 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 source table records (specified by ) into a target table (specified by ) 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.
IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting source table records (specified by ) into a target table (specified by ) 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.
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:
- TRUE
- FALSE
The default value is FALSE.

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

Definition at line 173 of file AppendRecords.cs.

Member Data Documentation

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

Optional filter expression to apply to the source_table_name.

The default value is ''.

Definition at line 192 of file AppendRecords.cs.

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

Definition at line 239 of file AppendRecords.cs.

const string kinetica.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).

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

const string kinetica.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 187 of file AppendRecords.cs.

const string kinetica.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 180 of file AppendRecords.cs.

const string kinetica.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 199 of file AppendRecords.cs.

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

Definition at line 238 of file AppendRecords.cs.

const string kinetica.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:

TRUE
FALSE

The default value is FALSE.

Definition at line 299 of file AppendRecords.cs.

const string kinetica.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.

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

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

Kinetica/Protocol/AppendRecords.cs

Public Attributes

Detailed Description

Member Data Documentation