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

More...

Public Attributes

const string EXPRESSION = "expression"
 Optional filter expression to apply to the table. More...
 
const string SORT_BY = "sort_by"
 Optional column(s) 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; e.g. 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"
 

Detailed Description

  • EXPRESSION: Optional filter expression to apply to the table.

SORT_BY: Optional column(s) 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. ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The default value is ''. CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. Supported values:

The default value is FALSE.

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

Definition at line 130 of file GetRecordsByColumn.cs.

Member Data Documentation

◆ ASCENDING

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

Definition at line 158 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 181 of file GetRecordsByColumn.cs.

◆ DESCENDING

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

Definition at line 159 of file GetRecordsByColumn.cs.

◆ EXPRESSION

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

Optional filter expression to apply to the table.

Definition at line 135 of file GetRecordsByColumn.cs.

◆ FALSE

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

Definition at line 183 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; e.g.

'timestamp asc, x desc'. The default value is ''.

Definition at line 164 of file GetRecordsByColumn.cs.

◆ SORT_BY

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

Optional column(s) that the data should be sorted by.

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

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

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

The default value is ASCENDING.

Definition at line 157 of file GetRecordsByColumn.cs.

◆ TRUE

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

Definition at line 182 of file GetRecordsByColumn.cs.


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