EXPRESSION: Optional filter expression to apply to the table.

More...

Public Attributes
const string	EXPRESSION = "expression"
	Optional filter expression to apply to the table. More...

const string	FAST_INDEX_LOOKUP = "fast_index_lookup"
	Indicates if indexes should be used to perform the lookup for a given expression if possible. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	SORT_BY = "sort_by"
	Optional column that the data should be sorted by. More...

const string	SORT_ORDER = "sort_order"
	String indicating how the returned values should be sorted - ascending or descending. More...

const string	ASCENDING = "ascending"

const string	DESCENDING = "descending"

Detailed Description

EXPRESSION: Optional filter expression to apply to the table.

FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values:

TRUE
FALSE

The default value is TRUE. SORT_BY: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:

The default value is ASCENDING.

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

Definition at line 121 of file GetRecords.cs.

Member Data Documentation

◆ ASCENDING

const string kinetica.GetRecordsRequest.Options.ASCENDING = "ascending"

Definition at line 171 of file GetRecords.cs.

◆ DESCENDING

const string kinetica.GetRecordsRequest.Options.DESCENDING = "descending"

Definition at line 172 of file GetRecords.cs.

◆ EXPRESSION

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

Optional filter expression to apply to the table.

Definition at line 126 of file GetRecords.cs.

◆ FALSE

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

Definition at line 148 of file GetRecords.cs.

◆ FAST_INDEX_LOOKUP

const string kinetica.GetRecordsRequest.Options.FAST_INDEX_LOOKUP = "fast_index_lookup"

Indicates if indexes should be used to perform the lookup for a given expression if possible.

Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 146 of file GetRecords.cs.

◆ SORT_BY

const string kinetica.GetRecordsRequest.Options.SORT_BY = "sort_by"

Optional column that the data should be sorted by.

Empty by default (i.e. no sorting is applied).

Definition at line 152 of file GetRecords.cs.

◆ SORT_ORDER

const string kinetica.GetRecordsRequest.Options.SORT_ORDER = "sort_order"

String indicating how the returned values should be sorted - ascending or descending.

If sort_order is provided, sort_by has to be provided. Supported values:

The default value is ASCENDING.

Definition at line 170 of file GetRecords.cs.

◆ TRUE

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

Definition at line 147 of file GetRecords.cs.

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

Kinetica/Protocol/GetRecords.cs

Public Attributes