kinetica.GetRecordsByColumnRequest

A set of parameters for Kinetica.getRecordsByColumn. More…

Inheritance diagram for kinetica.GetRecordsByColumnRequest:

Collaboration diagram for kinetica.GetRecordsByColumnRequest:

Classes
struct	Encoding
	A set of string constants for the parameter GetRecordsByColumnRequest.encoding. More…

struct	Options
	A set of string constants for the parameter GetRecordsByColumnRequest.options. More…

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

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

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

	GetRecordsByColumnRequest ()
	Constructs a GetRecordsByColumnRequest object with default parameters.

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

	GetRecordsByColumnRequest (string table_name, IList< string > column_names, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
	Constructs a GetRecordsByColumnRequest 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.

	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 on which this operation will be performed, in [schema_name.

IList< string >	column_names = new List<string>() `[get, set]`
	The list of column values to retrieve.

long	offset = 0 `[get, set]`
	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

long	limit = -9999 `[get, set]`
	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.

string	encoding = Encoding.BINARY `[get, set]`
	Specifies the encoding for returned records; either BINARY or JSON.

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`

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.

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.getRecordsByColumn.

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 GetRecordsByColumnRequest.offset and GetRecordsByColumnRequest.limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection.

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.

If GetRecordsByColumnRequest.table_name is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Definition at line 40 of file GetRecordsByColumn.cs.

Constructor & Destructor Documentation

◆ GetRecordsByColumnRequest() [1/6]

kinetica.GetRecordsByColumnRequest.GetRecordsByColumnRequest ( )

inline

Constructs a GetRecordsByColumnRequest object with default parameters.

Definition at line 309 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [2/6]

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

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

table_name	Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
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 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 results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options	EXPRESSION: Filter expression to apply to the table. SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”. 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 as well as the sort direction, 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. ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. The default value is an empty Dictionary.

Definition at line 433 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [3/6]

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

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

table_name	Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
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 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 results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
encoding	Specifies the encoding for returned records; either BINARY or JSON. Supported values: BINARY JSON The default value is BINARY.
options	EXPRESSION: Filter expression to apply to the table. SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”. 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 as well as the sort direction, 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. ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. The default value is an empty Dictionary.

Definition at line 588 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [4/6]

kinetica.GetRecordsByColumnRequest.GetRecordsByColumnRequest ( )

inline

Constructs a GetRecordsByColumnRequest object with default parameters.

Definition at line 309 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [5/6]

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

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

table_name	Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
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 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 results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options	EXPRESSION: Filter expression to apply to the table. SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”. 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 as well as the sort direction, 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. ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. The default value is an empty Dictionary.

Definition at line 433 of file GetRecordsByColumn.cs.

◆ GetRecordsByColumnRequest() [6/6]

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

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

table_name	Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
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 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 results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
encoding	Specifies the encoding for returned records; either BINARY or JSON. Supported values: BINARY JSON The default value is BINARY.
options	EXPRESSION: Filter expression to apply to the table. SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”. 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 as well as the sort direction, 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. ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. The default value is an empty Dictionary.

Definition at line 588 of file GetRecordsByColumn.cs.

Property Documentation

◆ column_names

IList< string > kinetica.GetRecordsByColumnRequest.column_names = new List<string>()

getset

The list of column values to retrieve.

Definition at line 165 of file GetRecordsByColumn.cs.

◆ encoding

string kinetica.GetRecordsByColumnRequest.encoding = Encoding.BINARY

getset

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

Supported values:

The default value is BINARY.

Definition at line 207 of file GetRecordsByColumn.cs.

◆ limit

long kinetica.GetRecordsByColumnRequest.limit = -9999

getset

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

The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and GetRecordsByColumnRequest.offset and GetRecordsByColumnRequest.limit to request subsequent pages of results. The default value is -9999.

Definition at line 186 of file GetRecordsByColumn.cs.

◆ offset

long kinetica.GetRecordsByColumnRequest.offset = 0

getset

A positive integer indicating the number of initial results to skip (this can be 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 171 of file GetRecordsByColumn.cs.

◆ options

IDictionary< string, string > kinetica.GetRecordsByColumnRequest.options = new Dictionary<string, string>()

getset

EXPRESSION: Filter expression to apply to the table.
SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”.
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 as well as the sort direction, 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.
ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.

The default value is an empty Dictionary.

Definition at line 305 of file GetRecordsByColumn.cs.

◆ table_name

string kinetica.GetRecordsByColumnRequest.table_name

getset

Name of the table or view on which this operation will be performed, in [schema_name.

]table_name format, using standard name resolution rules.

An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.

Definition at line 162 of file GetRecordsByColumn.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/GetRecordsByColumn.cs
Kinetica/Protocol/GetRecordsByColumn.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ GetRecordsByColumnRequest() [1/6]

​◆ GetRecordsByColumnRequest() [2/6]

​◆ GetRecordsByColumnRequest() [3/6]

​◆ GetRecordsByColumnRequest() [4/6]

​◆ GetRecordsByColumnRequest() [5/6]

​◆ GetRecordsByColumnRequest() [6/6]

​Property Documentation

​◆ column_names

​◆ encoding

​◆ limit

​◆ offset

​◆ options

​◆ table_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GetRecordsByColumnRequest() [1/6]

◆ GetRecordsByColumnRequest() [2/6]

◆ GetRecordsByColumnRequest() [3/6]

◆ GetRecordsByColumnRequest() [4/6]

◆ GetRecordsByColumnRequest() [5/6]

◆ GetRecordsByColumnRequest() [6/6]

Property Documentation

◆ column_names

◆ encoding

◆ limit

◆ offset

◆ options

◆ table_name