> ## 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.GetRecordsByColumnRequest > kinetica.GetRecordsByColumnRequest — Kinetica C# API

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\() \[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\() \[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 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: The default value is BINARY.
options 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 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: The default value is BINARY.
options 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\()
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\()
getset

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: