Kinetica   C#   API  Version 7.2.3.0
kinetica.GetRecordsByColumnRequest.Options Struct Reference

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

Public Attributes

const string EXPRESSION = "expression"
 Optional filter expression to apply to the table. More...
 
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"
 
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'. More...
 
const string CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs"
 If TRUE, then WKT string columns will be returned as WKB bytes. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string ROUTE_TO_TOM = "route_to_tom"
 For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. More...
 

Detailed Description

A set of string constants for the parameter options.

Definition at line 54 of file GetRecordsByColumn.cs.

Member Data Documentation

◆ ASCENDING

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

Definition at line 88 of file GetRecordsByColumn.cs.

◆ CONVERT_WKTS_TO_WKBS

const string kinetica.GetRecordsByColumnRequest.Options.CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs"

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

Supported values:

The default value is FALSE.

Definition at line 110 of file GetRecordsByColumn.cs.

◆ DESCENDING

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

Definition at line 89 of file GetRecordsByColumn.cs.

◆ EXPRESSION

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

Optional filter expression to apply to the table.

Definition at line 58 of file GetRecordsByColumn.cs.

◆ FALSE

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

Definition at line 113 of file GetRecordsByColumn.cs.

◆ ORDER_BY

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

The default value is ''.

Definition at line 95 of file GetRecordsByColumn.cs.

◆ ROUTE_TO_TOM

const string kinetica.GetRecordsByColumnRequest.Options.ROUTE_TO_TOM = "route_to_tom"

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

Definition at line 118 of file GetRecordsByColumn.cs.

◆ SORT_BY

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

Optional 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 68 of file GetRecordsByColumn.cs.

◆ SORT_ORDER

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

String indicating how the returned values should be sorted - ASCENDING or DESCENDING.

Supported values:

The default value is ASCENDING.

Definition at line 86 of file GetRecordsByColumn.cs.

◆ TRUE

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

Definition at line 112 of file GetRecordsByColumn.cs.


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