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

Inheritance diagram for kinetica.GetRecordsByColumnRequest:

Collaboration diagram for kinetica.GetRecordsByColumnRequest:

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

struct	Options
	expression Optional filter expression to apply to the table. More...

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

	GetRecordsByColumnRequest (string table_name, IList< string > column_names, long offset, long limit, IDictionary< string, string > options=null)
	Constructs a GetRecordsByColumnRequest object with the specified parameters. More...

	GetRecordsByColumnRequest (string table_name, IList< string > column_names, long offset, long limit, string encoding=null, IDictionary< string, string > options=null)
	Constructs a GetRecordsByColumnRequest 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 on which this operation will be performed. More...

IList< string >	column_names `[get, set]`
	The list of column values to retrieve. More...

long	offset = new List<string>() `[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 `[get, set]`
	A positive integer indicating the maximum number of results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. More...

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

IDictionary< string, string >	options = Encoding.BINARY `[get, set]`
	expression Optional filter expression to apply to the table. 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/bycolumn.

For a given table, retrieves the values of the given columns within a given range. It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset + limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.
Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Definition at line 33 of file GetRecordsByColumn.cs.

Constructor & Destructor Documentation

kinetica.GetRecordsByColumnRequest.GetRecordsByColumnRequest ( )

inline

Constructs a GetRecordsByColumnRequest object with default parameters.

Definition at line 170 of file GetRecordsByColumn.cs.

kinetica.GetRecordsByColumnRequest.GetRecordsByColumnRequest	(	string	table_name,
		IList< string >	column_names,
		long	offset,
		long	limit,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

table_name	Name of the table on which this operation will be performed. The table cannot be a parent set.
column_names	The list of column values to retrieve.
offset	A positive integer indicating the number of initial results to skip (this can be 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 results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
options	expression Optional filter expression to apply to the table. 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. Default is 'ascending'. If sort_order is provided, sort_by has to be provided. Values: ascending, descending. order_by Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 219 of file GetRecordsByColumn.cs.

kinetica.GetRecordsByColumnRequest.GetRecordsByColumnRequest	(	string	table_name,
		IList< string >	column_names,
		long	offset,
		long	limit,
		string	encoding = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

table_name	Name of the table on which this operation will be performed. The table cannot be a parent set.
column_names	The list of column values to retrieve.
offset	A positive integer indicating the number of initial results to skip (this can be 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 results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
encoding	Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.
options	expression Optional filter expression to apply to the table. 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. Default is 'ascending'. If sort_order is provided, sort_by has to be provided. Values: ascending, descending. order_by Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 284 of file GetRecordsByColumn.cs.

Property Documentation

IList<string> kinetica.GetRecordsByColumnRequest.column_names

getset

The list of column values to retrieve.

Definition at line 115 of file GetRecordsByColumn.cs.

string kinetica.GetRecordsByColumnRequest.encoding

getset

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

Values: binary, json.

Definition at line 132 of file GetRecordsByColumn.cs.

long kinetica.GetRecordsByColumnRequest.limit

getset

A positive integer indicating the maximum number of results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.

Definition at line 127 of file GetRecordsByColumn.cs.

long kinetica.GetRecordsByColumnRequest.offset = new List<string>()

getset

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

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

Definition at line 121 of file GetRecordsByColumn.cs.

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

getset

expression Optional filter expression to apply to the table.

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. Default is 'ascending'. If sort_order is provided, sort_by has to be provided. Values: ascending, descending. order_by Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 165 of file GetRecordsByColumn.cs.

string kinetica.GetRecordsByColumnRequest.table_name

getset

Name of the table on which this operation will be performed.

The table cannot be a parent set.

Definition at line 112 of file GetRecordsByColumn.cs.

The documentation for this class was generated from the following file:

Kinetica/Protocol/GetRecordsByColumn.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation