A set of parameters for Kinetica.getRecordsBySeries. More...
Inheritance diagram for kinetica.GetRecordsBySeriesRequest:
Collaboration diagram for kinetica.GetRecordsBySeriesRequest:
Classes | |
| struct | Encoding |
| A set of string constants for the parameter encoding. More... | |
Public Member Functions | |
| GetRecordsBySeriesRequest () | |
| Constructs a GetRecordsBySeriesRequest object with default parameters. More... | |
| GetRecordsBySeriesRequest (string table_name, string world_table_name, int? offset=null, int? limit=null, IDictionary< string, string > options=null) | |
| Constructs a GetRecordsBySeriesRequest object with the specified parameters. More... | |
| GetRecordsBySeriesRequest (string table_name, string world_table_name, int? offset=null, int? limit=null, string encoding=null, IDictionary< string, string > options=null) | |
| Constructs a GetRecordsBySeriesRequest 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 for which series/tracks will be fetched, in [schema_name. More... | |
| string | world_table_name [get, set] |
| Name of the table containing the complete series/track information to be returned for the tracks present in the table_name, in [schema_name. More... | |
| int | offset = 0 [get, set] |
| A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). More... | |
| int | limit = 250 [get, set] |
| A positive integer indicating the maximum number of series/tracks to be returned. More... | |
| string | encoding = Encoding.BINARY [get, set] |
| Specifies the encoding for returned records; either BINARY or JSON. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| 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.getRecordsBySeries.
Retrieves the complete series/track records from the given world_table_name based on the partial track information contained in the table_name.
This operation supports paging through the data via the offset and limit parameters.
In contrast to Kinetica.getRecords this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in table_name. Each series/track will be returned sorted by their TIMESTAMP column.
Definition at line 25 of file GetRecordsBySeries.cs.
Constructor & Destructor Documentation
◆ GetRecordsBySeriesRequest() [1/3]
|
inline |
Constructs a GetRecordsBySeriesRequest object with default parameters.
Definition at line 92 of file GetRecordsBySeries.cs.
◆ GetRecordsBySeriesRequest() [2/3]
|
inline |
Constructs a GetRecordsBySeriesRequest object with the specified parameters.
- Parameters
-
table_name Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. world_table_name Name of the table containing the complete series/track information to be returned for the tracks present in the table_name , in [schema_name.]table_name format, using standard name resolution rules. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank. offset A positive integer indicating the number of initial series/tracks to skip (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 series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250. options Optional parameters. The default value is an empty Dictionary.
Definition at line 121 of file GetRecordsBySeries.cs.
◆ GetRecordsBySeriesRequest() [3/3]
|
inline |
Constructs a GetRecordsBySeriesRequest object with the specified parameters.
- Parameters
-
table_name Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. world_table_name Name of the table containing the complete series/track information to be returned for the tracks present in the table_name , in [schema_name.]table_name format, using standard name resolution rules. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank. offset A positive integer indicating the number of initial series/tracks to skip (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 series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250. encoding Specifies the encoding for returned records; either BINARY or JSON. Supported values: The default value is BINARY. options Optional parameters. The default value is an empty Dictionary.
Definition at line 176 of file GetRecordsBySeries.cs.
Property Documentation
◆ encoding
|
getset |
◆ limit
|
getset |
A positive integer indicating the maximum number of series/tracks to be returned.
Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.
Definition at line 67 of file GetRecordsBySeries.cs.
◆ offset
|
getset |
A positive integer indicating the number of initial series/tracks to skip (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 60 of file GetRecordsBySeries.cs.
◆ options
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 88 of file GetRecordsBySeries.cs.
◆ table_name
|
getset |
Name of the table or view for which series/tracks will be fetched, in [schema_name.
]table_name format, using standard name resolution rules.
Definition at line 42 of file GetRecordsBySeries.cs.
◆ world_table_name
|
getset |
Name of the table containing the complete series/track information to be returned for the tracks present in the table_name, in [schema_name.
]table_name format, using standard name resolution rules.
Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
Definition at line 53 of file GetRecordsBySeries.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/GetRecordsBySeries.cs
