A set of parameters for Kinetica.getRecordsByColumn(string,IList<string>,long,long,IDictionary<string, string>). 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 Kinetica.getRecordsByColumn(string,IList<string>,long,long,IDictionary<string, string>).

For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection(string,string,IList<string>,IDictionary<string, string>).
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Definition at line 38 of file GetRecordsByColumn.cs.

Constructor & Destructor Documentation

◆ GetRecordsByColumnRequest() [1/3]

kinetica.GetRecordsByColumnRequest.GetRecordsByColumnRequest ( )

inline

Constructs a GetRecordsByColumnRequest object with default parameters.

Definition at line 292 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [2/3]

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(s) 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: ASCENDING DESCENDING The default value is ASCENDING. ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The default value is ''. CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 373 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [3/3]

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'. Supported values: BINARY JSON The default value is BINARY.
options	EXPRESSION: Optional filter expression to apply to the table. SORT_BY: Optional column(s) 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: ASCENDING DESCENDING The default value is ASCENDING. ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The default value is ''. CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 483 of file GetRecordsByColumn.cs.

Property Documentation

◆ column_names

IList<string> kinetica.GetRecordsByColumnRequest.column_names

getset

The list of column values to retrieve.

Definition at line 192 of file GetRecordsByColumn.cs.

◆ encoding

string kinetica.GetRecordsByColumnRequest.encoding

getset

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

Supported values:

BINARY
JSON

The default value is BINARY.

Definition at line 222 of file GetRecordsByColumn.cs.

◆ limit

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 204 of file GetRecordsByColumn.cs.

◆ offset

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 198 of file GetRecordsByColumn.cs.

◆ options

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

getset

EXPRESSION: Optional filter expression to apply to the table.

SORT_BY: Optional column(s) 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. ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The default value is ''. CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. Supported values:

TRUE
FALSE

The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 287 of file GetRecordsByColumn.cs.

◆ table_name

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 189 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

◆ GetRecordsByColumnRequest() [1/3]

◆ GetRecordsByColumnRequest() [2/3]

◆ GetRecordsByColumnRequest() [3/3]

Property Documentation

◆ column_names

◆ encoding

◆ limit

◆ offset

◆ options

◆ table_name