A set of parameters for Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>). More...

Inheritance diagram for kinetica.GetRecordsFromCollectionRequest:

Collaboration diagram for kinetica.GetRecordsFromCollectionRequest:

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

struct	Options
	RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. More...

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

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

	GetRecordsFromCollectionRequest (string table_name, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
	Constructs a GetRecordsFromCollectionRequest 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 or table from which records are to be retrieved. More...

long	offset `[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 = 0 `[get, set]`
	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. More...

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

IDictionary< string, string >	options = Encoding.BINARY `[get, set]`
	RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. 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.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>).

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords(string,IList<string>,IDictionary<string, string>).
This operation supports paging through the data via the offset and limit parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Definition at line 28 of file GetRecordsFromCollection.cs.

Constructor & Destructor Documentation

◆ GetRecordsFromCollectionRequest() [1/3]

kinetica.GetRecordsFromCollectionRequest.GetRecordsFromCollectionRequest ( )

inline

Constructs a GetRecordsFromCollectionRequest object with default parameters.

Definition at line 166 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() [2/3]

kinetica.GetRecordsFromCollectionRequest.GetRecordsFromCollectionRequest	(	string	table_name,
		long?	offset = `null`,
		long?	limit = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a GetRecordsFromCollectionRequest object with the specified parameters.

Parameters

table_name	Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.
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 max number of results should be returned. The default value is 10000.
options	RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 206 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() [3/3]

kinetica.GetRecordsFromCollectionRequest.GetRecordsFromCollectionRequest	(	string	table_name,
		long?	offset = `null`,
		long?	limit = `null`,
		string	encoding = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a GetRecordsFromCollectionRequest object with the specified parameters.

Parameters

table_name	Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.
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 max number of results should be returned. The default value is 10000.
encoding	Specifies the encoding for returned records; either 'binary' or 'json'. Supported values: BINARY JSON The default value is BINARY.
options	RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 273 of file GetRecordsFromCollection.cs.

Property Documentation

◆ encoding

string kinetica.GetRecordsFromCollectionRequest.encoding = 10000

getset

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

Supported values:

BINARY
JSON

The default value is BINARY.

Definition at line 136 of file GetRecordsFromCollection.cs.

◆ limit

long kinetica.GetRecordsFromCollectionRequest.limit = 0

getset

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

The default value is 10000.

Definition at line 118 of file GetRecordsFromCollection.cs.