> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.GetRecordsBySeriesRequest > kinetica.GetRecordsBySeriesRequest — Kinetica C# API

A set of parameters for Kinetica.getRecordsBySeries. More...

Classes

struct   Encoding
  A set of string constants for the parameter GetRecordsBySeriesRequest.encoding. More...
 

Public Member Functions

  GetRecordsBySeriesRequest ()
  Constructs a GetRecordsBySeriesRequest object with default parameters.
 
  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.
 
  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.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties

string  table\_name \[get, set]
  Name of the table or view for which series/tracks will be fetched, in \[schema\_name.
 
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 GetRecordsBySeriesRequest.table\_name, in \[schema\_name.
 
int  offset = 0 \[get, set]
  A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results).
 
int  limit = 250 \[get, set]
  A positive integer indicating the maximum number of series/tracks to be returned.
 
string  encoding = Encoding.BINARY \[get, set]
  Specifies the encoding for returned records; either BINARY or JSON.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 

Detailed Description

A set of parameters for Kinetica.getRecordsBySeries.

Retrieves the complete series/track records from the given GetRecordsBySeriesRequest.world\_table\_name based on the partial track information contained in the GetRecordsBySeriesRequest.table\_name.

This operation supports paging through the data via the GetRecordsBySeriesRequest.offset and GetRecordsBySeriesRequest.limit parameters.

In contrast to Kinetica.getRecords this returns records grouped by series/track. So if GetRecordsBySeriesRequest.offset is 0 and GetRecordsBySeriesRequest.limit is 5 this operation would return the first 5 series/tracks in GetRecordsBySeriesRequest.table\_name. Each series/track will be returned sorted by their TIMESTAMP column.

Definition at line 28 of file GetRecordsBySeries.cs.

Constructor & Destructor Documentation

◆ GetRecordsBySeriesRequest() \[1/3]

kinetica.GetRecordsBySeriesRequest.GetRecordsBySeriesRequest ( )
inline

Constructs a GetRecordsBySeriesRequest object with default parameters.

Definition at line 106 of file GetRecordsBySeries.cs.

◆ GetRecordsBySeriesRequest() \[2/3]

kinetica.GetRecordsBySeriesRequest.GetRecordsBySeriesRequest ( string table\_name,
string world\_table\_name,
int? offset = null,
int? limit = null,
IDictionary\< string, string > options = null )
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 135 of file GetRecordsBySeries.cs.

◆ GetRecordsBySeriesRequest() \[3/3]

kinetica.GetRecordsBySeriesRequest.GetRecordsBySeriesRequest ( string table\_name,
string world\_table\_name,
int? offset = null,
int? limit = null,
string encoding = null,
IDictionary\< string, string > options = null )
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 195 of file GetRecordsBySeries.cs.

Property Documentation

◆ encoding

string kinetica.GetRecordsBySeriesRequest.encoding = Encoding.BINARY
getset

Specifies the encoding for returned records; either BINARY or JSON.

Supported values:

The default value is BINARY.

Definition at line 97 of file GetRecordsBySeries.cs.

◆ limit

int kinetica.GetRecordsBySeriesRequest.limit = 250
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 76 of file GetRecordsBySeries.cs.

◆ offset

int kinetica.GetRecordsBySeriesRequest.offset = 0
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 70 of file GetRecordsBySeries.cs.

◆ options

IDictionary\ kinetica.GetRecordsBySeriesRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 102 of file GetRecordsBySeries.cs.

◆ table\_name

string kinetica.GetRecordsBySeriesRequest.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 51 of file GetRecordsBySeries.cs.

◆ world\_table\_name

string kinetica.GetRecordsBySeriesRequest.world\_table\_name
getset

Name of the table containing the complete series/track information to be returned for the tracks present in the GetRecordsBySeriesRequest.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 63 of file GetRecordsBySeries.cs.

The documentation for this class was generated from the following file:
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.