Object that permits efficient retrieval of records from GPUdb, with support for multi-head access and HA failover. More…
Public Member Functions | |
| RecordRetriever (Kinetica kdb, string table_name, KineticaType ktype, WorkerList? workers=null) | |
| Create a RecordRetriever object with the given parameters. | |
| GetRecordsResponse< T > | getRecordsByKey (T record, string? expression=null) |
| Retrieves records for a given shard key, optionally further limited by an additional expression. | |
| RecordRetriever (Kinetica kdb, string table_name, KineticaType ktype, WorkerList? workers=null) | |
| Create a RecordRetriever object with the given parameters. | |
| GetRecordsResponse< T > | getRecordsByKey (T record, string? expression=null) |
| Retrieves records for a given shard key, optionally further limited by an additional expression. | |
Properties | |
| Kinetica | KineticaDB [get] |
| Gets the Kinetica connection. | |
| string | TableName [get] |
| Gets the table name. | |
| int | NumClusterSwitches [get] |
| Gets the number of cluster switches due to HA failover. | |
| int | HARingSize [get] |
| Gets the HA ring size. | |
Detailed Description
Object that permits efficient retrieval of records from GPUdb, with support for multi-head access and HA failover.
RecordRetriever instances are thread safe and may be used from any number of threads simultaneously.
This implementation matches the Rust RecordRetriever with full HA support.
| T | The type of object being retrieved. |
| T | : | new() |
Definition at line 16 of file RecordRetriever.cs.
Member Function Documentation
◆ getRecordsByKey() [1/2]
| 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.
| record | The record based on whose shard column values records will be fetched from the table. |
| expression | An optional expression. Default is null. |
Definition at line 363 of file RecordRetriever.cs.
◆ getRecordsByKey() [2/2]
| 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.
| record | The record based on whose shard column values records will be fetched from the table. |
| expression | An optional expression. Default is null. |
Definition at line 363 of file RecordRetriever.cs.
◆ RecordRetriever() [1/2]
| inline |
Create a RecordRetriever object with the given parameters.
| kdb | The Kinetica connection. |
| table_name | The table name to retrieve from. |
| ktype | The KineticaType for the table. |
| workers | Optional worker list for multi-head retrieval. |
Definition at line 79 of file RecordRetriever.cs.
◆ RecordRetriever() [2/2]
| inline |
Create a RecordRetriever object with the given parameters.
| kdb | The Kinetica connection. |
| table_name | The table name to retrieve from. |
| ktype | The KineticaType for the table. |
| workers | Optional worker list for multi-head retrieval. |
Definition at line 79 of file RecordRetriever.cs.
Property Documentation
◆ HARingSize
| get |
Gets the HA ring size.
Definition at line 66 of file RecordRetriever.cs.
◆ KineticaDB
| get |
Gets the Kinetica connection.
Definition at line 51 of file RecordRetriever.cs.
◆ NumClusterSwitches
| get |
Gets the number of cluster switches due to HA failover.
Definition at line 61 of file RecordRetriever.cs.
◆ TableName
| get |
Gets the table name.
Definition at line 56 of file RecordRetriever.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/RecordRetriever.cs
- Kinetica/RecordRetriever.cs