Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.GetRecordsRequest.Options Struct Reference

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 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]. 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. Values: ascending, descending.


A set of string constants for the parameter <member name="options">.

Definition at line 76 of file GetRecords.cs.

Member Data Documentation

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

Definition at line 100 of file GetRecords.cs.

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

Definition at line 101 of file GetRecords.cs.

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

Optional filter expression to apply to the table.

Definition at line 81 of file GetRecords.cs.

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]. The default value is true.

Definition at line 89 of file GetRecords.cs.

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 93 of file GetRecords.cs.

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. Values: ascending, descending.

Definition at line 99 of file GetRecords.cs.

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