Skip to main content

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

​
Static Public Attributes

const string EXPRESSION = “expression”
 Filter expression to apply to the table.
 
const string SORT_BY = “sort_by”
 Column that the data should be sorted by.
 
const string SORT_ORDER = “sort_order”
 String indicating how the returned values should be sorted.
 
const string ASCENDING = “ascending”
 A constant for the GetRecordsByColumnRequest.Options options.
 
const string DESCENDING = “descending”
 A constant for the GetRecordsByColumnRequest.Options options.
 
const string ORDER_BY = “order_by”
 Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’.
 
const string CONVERT_WKTS_TO_WKBS = “convert_wkts_to_wkbs”
 If TRUE, then WKT string columns will be returned as WKB bytes.
 
const string TRUE = “true”
 A boolean constant for the GetRecordsByColumnRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the GetRecordsByColumnRequest.Options options.
 
const string ROUTE_TO_TOM = “route_to_tom”
 For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
 

​
Detailed Description

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

Definition at line 61 of file GetRecordsByColumn.cs.

​
Member Data Documentation

​
◆ ASCENDING

const string kinetica.GetRecordsByColumnRequest.Options.ASCENDING = “ascending”
 static

A constant for the GetRecordsByColumnRequest.Options options.

Definition at line 109 of file GetRecordsByColumn.cs.

​
◆ CONVERT_WKTS_TO_WKBS

const string kinetica.GetRecordsByColumnRequest.Options.CONVERT_WKTS_TO_WKBS = “convert_wkts_to_wkbs”
 static

If TRUE, then WKT string columns will be returned as WKB bytes.

Supported values:

The default value is FALSE.

Definition at line 140 of file GetRecordsByColumn.cs.

​
◆ DESCENDING

const string kinetica.GetRecordsByColumnRequest.Options.DESCENDING = “descending”
 static

A constant for the GetRecordsByColumnRequest.Options options.

Definition at line 113 of file GetRecordsByColumn.cs.

​
◆ EXPRESSION

const string kinetica.GetRecordsByColumnRequest.Options.EXPRESSION = “expression”
 static

Filter expression to apply to the table.

Definition at line 64 of file GetRecordsByColumn.cs.

​
◆ FALSE

const string kinetica.GetRecordsByColumnRequest.Options.FALSE = “false”
 static

A boolean constant for the GetRecordsByColumnRequest.Options options.

Definition at line 148 of file GetRecordsByColumn.cs.

​
◆ ORDER_BY

const string kinetica.GetRecordsByColumnRequest.Options.ORDER_BY = “order_by”
 static

Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’.

The default value is ”.

Definition at line 119 of file GetRecordsByColumn.cs.

​
◆ ROUTE_TO_TOM

const string kinetica.GetRecordsByColumnRequest.Options.ROUTE_TO_TOM = “route_to_tom”
 static

For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.

Definition at line 152 of file GetRecordsByColumn.cs.

​
◆ SORT_BY

const string kinetica.GetRecordsByColumnRequest.Options.SORT_BY = “sort_by”
 static

Column that the data should be sorted by.

Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”.

Definition at line 76 of file GetRecordsByColumn.cs.

​
◆ SORT_ORDER

const string kinetica.GetRecordsByColumnRequest.Options.SORT_ORDER = “sort_order”
 static

String indicating how the returned values should be sorted.

If SORT_ORDER is provided, SORT_BY has to be provided. Supported values:

The default value is ASCENDING.

Definition at line 105 of file GetRecordsByColumn.cs.

​
◆ TRUE

const string kinetica.GetRecordsByColumnRequest.Options.TRUE = “true”
 static

A boolean constant for the GetRecordsByColumnRequest.Options options.

Definition at line 144 of file GetRecordsByColumn.cs.

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