A set of parameters for /get/records/byseries. More...

Inheritance diagram for kinetica.GetRecordsBySeriesRequest:

Collaboration diagram for kinetica.GetRecordsBySeriesRequest:

Classes
struct	Encoding
	Specifies the encoding for returned records; either 'binary' or 'json'. More...

Public Member Functions
	GetRecordsBySeriesRequest ()
	Constructs a GetRecordsBySeriesRequest object with default parameters. More...

	GetRecordsBySeriesRequest (string table_name, string world_table_name, int offset=0, int limit=250, IDictionary< string, string > options=null)
	Constructs a GetRecordsBySeriesRequest object with the specified parameters. More...

	GetRecordsBySeriesRequest (string table_name, string world_table_name, int offset=0, int limit=250, 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 collection/table/view for which series/tracks will be fetched. 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 . More...

int	offset `[get, set]`
	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). More...

int	limit = 0 `[get, set]`
	A positive integer indicating the maximum number of series/tracks to be returned. More...

string	encoding = 250 `[get, set]`
	Specifies the encoding for returned records; either 'binary' or 'json'. More...

IDictionary< string, string >	options = Encoding.BINARY `[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 /get/records/byseries.

Retrieves the complete series/track records from the given <member name="world_table_name"> based on the partial track information contained in the <member name="table_name">.
This operation supports paging through the data via the <member name="offset"> and <member name="limit"> parameters.
In contrast to /get/records this returns records grouped by series/track. So if <member name="offset"> is 0 and <member name="limit"> is 5 this operation would return the first 5 series/tracks in <member name="table_name">. Each series/track will be returned sorted by their TIMESTAMP column.

Definition at line 28 of file GetRecordsBySeries.cs.

Constructor & Destructor Documentation

kinetica.GetRecordsBySeriesRequest.GetRecordsBySeriesRequest ( )

inline

Constructs a GetRecordsBySeriesRequest object with default parameters.

Definition at line 77 of file GetRecordsBySeries.cs.

kinetica.GetRecordsBySeriesRequest.GetRecordsBySeriesRequest	(	string	table_name,
		string	world_table_name,
		int	offset = `0`,
		int	limit = `250`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Parameters

table_name	Name of the collection/table/view for which series/tracks will be fetched.
world_table_name	Name of the table containing the complete series/track information to be returned for the tracks present in the . 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 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.
options	Optional parameters.

Definition at line 101 of file GetRecordsBySeries.cs.

kinetica.GetRecordsBySeriesRequest.GetRecordsBySeriesRequest	(	string	table_name,
		string	world_table_name,
		int	offset = `0`,
		int	limit = `250`,
		string	encoding = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Parameters

table_name	Name of the collection/table/view for which series/tracks will be fetched.
world_table_name	Name of the table containing the complete series/track information to be returned for the tracks present in the . 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 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.
encoding	Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.
options	Optional parameters.

Definition at line 141 of file GetRecordsBySeries.cs.

Property Documentation

string kinetica.GetRecordsBySeriesRequest.encoding = 250

getset

Specifies the encoding for returned records; either 'binary' or 'json'.

Values: binary, json.

Definition at line 69 of file GetRecordsBySeries.cs.

int kinetica.GetRecordsBySeriesRequest.limit = 0

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.

Definition at line 64 of file GetRecordsBySeries.cs.

int kinetica.GetRecordsBySeriesRequest.offset

getset

A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results).

The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 59 of file GetRecordsBySeries.cs.

IDictionary<string, string> kinetica.GetRecordsBySeriesRequest.options = Encoding.BINARY

getset

Optional parameters.

Definition at line 72 of file GetRecordsBySeries.cs.

string kinetica.GetRecordsBySeriesRequest.table_name

getset

Name of the collection/table/view for which series/tracks will be fetched.

Definition at line 45 of file GetRecordsBySeries.cs.

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 .

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

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation