> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.GetRecordsFromCollectionRequest > kinetica.GetRecordsFromCollectionRequest — Kinetica C# API

A set of parameters for Kinetica.getRecordsFromCollection. More...

Inheritance diagram for kinetica.GetRecordsFromCollectionRequest:
Collaboration diagram for kinetica.GetRecordsFromCollectionRequest:

Classes
struct   Encoding
  A set of string constants for the parameter GetRecordsFromCollectionRequest.encoding. More...
 
struct   Options
  A set of string constants for the parameter GetRecordsFromCollectionRequest.options. More...
 

Public Member Functions
  GetRecordsFromCollectionRequest ()
  Constructs a GetRecordsFromCollectionRequest object with default parameters.
 
  GetRecordsFromCollectionRequest (string table\_name, long? offset=null, long? limit=null, IDictionary\< string, string > options=null)
  Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
 
  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.
 
  GetRecordsFromCollectionRequest ()
  Constructs a GetRecordsFromCollectionRequest object with default parameters.
 
  GetRecordsFromCollectionRequest (string table\_name, long? offset=null, long? limit=null, IDictionary\< string, string > options=null)
  Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
 
  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.
 
 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 collection or table from which records are to be retrieved, in \[schema\_name.
 
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\() \[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.getRecordsFromCollection.

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords.

This operation supports paging through the data via the GetRecordsFromCollectionRequest.offset and GetRecordsFromCollectionRequest.limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)

Definition at line 24 of file GetRecordsFromCollection.cs.

Constructor & Destructor Documentation

◆ GetRecordsFromCollectionRequest() \[1/6]

kinetica.GetRecordsFromCollectionRequest.GetRecordsFromCollectionRequest ( )
inline

Constructs a GetRecordsFromCollectionRequest object with default parameters.

Definition at line 174 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() \[2/6]

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, in \[schema\_name.]table\_name format, using standard name resolution rules. 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 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 offset and limit to request subsequent pages of results. The default value is -9999.
options The default value is an empty Dictionary.

Definition at line 232 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() \[3/6]

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, in \[schema\_name.]table\_name format, using standard name resolution rules. 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 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 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: The default value is BINARY.
options The default value is an empty Dictionary.

Definition at line 320 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() \[4/6]

kinetica.GetRecordsFromCollectionRequest.GetRecordsFromCollectionRequest ( )
inline

Constructs a GetRecordsFromCollectionRequest object with default parameters.

Definition at line 174 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() \[5/6]

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, in \[schema\_name.]table\_name format, using standard name resolution rules. 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 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 offset and limit to request subsequent pages of results. The default value is -9999.
options The default value is an empty Dictionary.

Definition at line 232 of file GetRecordsFromCollection.cs.

◆ GetRecordsFromCollectionRequest() \[6/6]

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, in \[schema\_name.]table\_name format, using standard name resolution rules. 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 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 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: The default value is BINARY.
options The default value is an empty Dictionary.

Definition at line 320 of file GetRecordsFromCollection.cs.

Property Documentation

◆ encoding

string kinetica.GetRecordsFromCollectionRequest.encoding = Encoding.BINARY
getset

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

Supported values:

The default value is BINARY.

Definition at line 133 of file GetRecordsFromCollection.cs.

◆ limit

long kinetica.GetRecordsFromCollectionRequest.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 GetRecordsFromCollectionRequest.offset and GetRecordsFromCollectionRequest.limit to request subsequent pages of results. The default value is -9999.

Definition at line 111 of file GetRecordsFromCollection.cs.

◆ offset

long kinetica.GetRecordsFromCollectionRequest.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 98 of file GetRecordsFromCollection.cs.

◆ options

IDictionary\< string, string > kinetica.GetRecordsFromCollectionRequest.options = new Dictionary\()
getset

The default value is an empty Dictionary.

Definition at line 170 of file GetRecordsFromCollection.cs.

◆ table\_name

string kinetica.GetRecordsFromCollectionRequest.table\_name
getset

Name of the collection or table from which records are to be retrieved, in \[schema\_name.

]table\_name format, using standard name resolution rules.

Must be an existing collection or table.

Definition at line 92 of file GetRecordsFromCollection.cs.

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