A set of parameters for Kinetica.getRecords. More...
Inheritance diagram for kinetica.GetRecordsRequest:
Collaboration diagram for kinetica.GetRecordsRequest:
Classes | |
| struct | Encoding |
| A set of string constants for the parameter encoding. More... | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
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 or view from which the records will be fetched, in [schema_name. More... | |
| long | offset = 0 [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 = -9999 [get, set] |
| A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. More... | |
| string | encoding = Encoding.BINARY [get, set] |
| Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. 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 24 of file GetRecords.cs.
Constructor & Destructor Documentation
◆ GetRecordsRequest() [1/3]
|
inline |
Constructs a GetRecordsRequest object with default parameters.
Definition at line 201 of file GetRecords.cs.
◆ GetRecordsRequest() [2/3]
|
inline |
Constructs a GetRecordsRequest object with the specified parameters.
- Parameters
-
table_name Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999. 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 283 of file GetRecords.cs.
◆ GetRecordsRequest() [3/3]
|
inline |
Constructs a GetRecordsRequest object with the specified parameters.
- Parameters
-
table_name Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999. encoding Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON. 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 393 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 maximum number of results allowed by the server should be returned.
The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
Definition at line 118 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 103 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 197 of file GetRecords.cs.
◆ table_name
|
getset |
Name of the table or view from which the records will be fetched, in [schema_name.
]table_name format, using standard name resolution rules.
Definition at line 96 of file GetRecords.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/GetRecords.cs
