Kinetica   C#   API  Version 7.2.3.1
WorkerQueue< T > Class Template Reference

Public Member Functions

 WorkerQueue (System.Uri url)
 Creates an insertion queue for a given worker. More...
 
 WorkerQueue (System.Uri url, int capacity, bool hasPrimaryKey, bool updateOnExistingPk)
 Creates an insertion queue for a given worker. More...
 
IList< T > flush ()
 Returns the current queue and creates a new empty one. More...
 
IList< T >? insert (T record, RecordKey key)
 Inserts a record into the queue (if all conditions are favourable). More...
 

Properties

System.Uri url [get]
 

Detailed Description

Definition at line 7 of file WorkerQueue.cs.

Constructor & Destructor Documentation

◆ WorkerQueue() [1/2]

WorkerQueue< T >.WorkerQueue ( System.Uri  url)
inline

Creates an insertion queue for a given worker.

Parameters
url

Definition at line 18 of file WorkerQueue.cs.

◆ WorkerQueue() [2/2]

WorkerQueue< T >.WorkerQueue ( System.Uri  url,
int  capacity,
bool  hasPrimaryKey,
bool  updateOnExistingPk 
)
inline

Creates an insertion queue for a given worker.

Parameters
url
capacity
hasPrimaryKeyReserved for future use.
updateOnExistingPkReserved for future use.

Definition at line 35 of file WorkerQueue.cs.

Member Function Documentation

◆ flush()

IList<T> WorkerQueue< T >.flush ( )
inline

Returns the current queue and creates a new empty one.

Returns
A list of records to be inserted.

Definition at line 52 of file WorkerQueue.cs.

◆ insert()

IList<T>? WorkerQueue< T >.insert ( record,
RecordKey  key 
)
inline

Inserts a record into the queue (if all conditions are favourable).

Returns the queue if it becomes full upon insertion.

Parameters
recordThe record to insert into the queue.
keyA primary key, if any.
Returns
The list of records (if the queue is full), or null.

Definition at line 69 of file WorkerQueue.cs.

Property Documentation

◆ url

System.Uri WorkerQueue< T >.url
get

Definition at line 9 of file WorkerQueue.cs.


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