Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.RecordRetriever< T > Class Template Reference

Manages the insertion into GPUdb of large numbers of records in bulk, with automatic batch management and support for multi-head ingest. More...

Public Member Functions

 RecordRetriever (Kinetica kdb, string table_name, KineticaType ktype, Utils.WorkerList workers=null)
 Create a RecordRetriever object with the given parameters. More...
 
GetRecordsResponse< T > getRecordsByKey (T record, string expression=null)
 Retrieves records for a given shard key, optionally further limited by an additional expression. More...
 

Properties

Kinetica kineticaDB [get]
 
string table_name [get]
 

Detailed Description

Manages the insertion into GPUdb of large numbers of records in bulk, with automatic batch management and support for multi-head ingest.

Use the insert(record) and insert(List) methods to queue records for insertion, and the flush method to ensure that all queued records have been inserted.

Template Parameters
TThe type of object being inserted.
Type Constraints
T :new() 

Definition at line 16 of file RecordRetriever.cs.

Constructor & Destructor Documentation

kinetica.RecordRetriever< T >.RecordRetriever ( Kinetica  kdb,
string  table_name,
KineticaType  ktype,
Utils.WorkerList  workers = null 
)
inline

Create a RecordRetriever object with the given parameters.

Parameters
kdb
table_name
ktype
workers

Definition at line 35 of file RecordRetriever.cs.

Member Function Documentation

GetRecordsResponse<T> kinetica.RecordRetriever< T >.getRecordsByKey ( record,
string  expression = null 
)
inline

Retrieves records for a given shard key, optionally further limited by an additional expression.

All records matching the key and satisfying the expression will be returned, up to the system-defined limit. For multi-head mode the request will be sent directly to the appropriate worker.
All fields in both the shard key and the expression must have defined attribute indexes, unless the shard key is also a primary key and all referenced fields are in the primary key. The expression must be limited to basic equality and inequality comparisons that can be evaluated using the attribute indexes.

Parameters
recordThe record based on whose shard column values records will be fetched from the table.
expressionAn optional expression. Default is null.
Returns
A GetRecordsResponse object with the decoded retrieved values.

Definition at line 124 of file RecordRetriever.cs.

Property Documentation

Kinetica kinetica.RecordRetriever< T >.kineticaDB
get

Definition at line 19 of file RecordRetriever.cs.

string kinetica.RecordRetriever< T >.table_name
get

Definition at line 20 of file RecordRetriever.cs.


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