A set of parameters for Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>). More...
Inheritance diagram for kinetica.GetRecordsRequest:
Collaboration diagram for kinetica.GetRecordsRequest:
Classes | |
| struct | Encoding |
| Specifies the encoding for returned records. More... | |
| struct | Options |
| |
Public Member Functions | |
| GetRecordsRequest () | |
| Constructs a GetRecordsRequest object with default parameters. More... | |
| GetRecordsRequest (string table_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null) | |
| Constructs a GetRecordsRequest object with the specified parameters. More... | |
| GetRecordsRequest (string table_name, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null) | |
| Constructs a GetRecordsRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | table_name [get, set] |
| Name of the table from which the records will be fetched. More... | |
| long | offset [get, set] |
| A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More... | |
| long | limit = 0 [get, set] |
| A positive integer indicating the maximum number of results to be returned. More... | |
| string | encoding = 10000 [get, set] |
| Specifies the encoding for returned records. More... | |
| IDictionary< string, string > | options = Encoding.BINARY [get, set] |
| |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
Definition at line 30 of file GetRecords.cs.
Constructor & Destructor Documentation
◆ GetRecordsRequest() [1/3]
|
inline |
Constructs a GetRecordsRequest object with default parameters.
Definition at line 275 of file GetRecords.cs.
◆ GetRecordsRequest() [2/3]
|
inline |
Constructs a GetRecordsRequest object with the specified parameters.
- Parameters
-
table_name Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. offset A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. limit A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000. options - 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: 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.
Definition at line 350 of file GetRecords.cs.
◆ GetRecordsRequest() [3/3]
|
inline |
Constructs a GetRecordsRequest object with the specified parameters.
- Parameters
-
table_name Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. offset A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. limit A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000. encoding Specifies the encoding for returned records. Supported values: The default value is BINARY. options - 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: 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.
Definition at line 454 of file GetRecords.cs.
Property Documentation
◆ encoding
|
getset |
◆ limit
|
getset |
A positive integer indicating the maximum number of results to be returned.
Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000.
Definition at line 190 of file GetRecords.cs.
◆ offset
|
getset |
A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
Definition at line 184 of file GetRecords.cs.
◆ options
|
getset |
- 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:
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.
Definition at line 270 of file GetRecords.cs.
◆ table_name
|
getset |
Name of the table from which the records will be fetched.
Must be a table, view or homogeneous collection.
Definition at line 178 of file GetRecords.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/GetRecords.cs
