RecordRetriever

Creates a retriever of the records of table_name, which are of record_type, returning them as GenericRecords.

The worker list is derived from the connection’s own worker addresses, and records are retrieved with no options.

use gpudb_api::{Kinetica, KineticaOptions, RecordRetriever, Type};
use std::sync::Arc;

let options = KineticaOptions::new();
let kinetica = Arc::new(
    Kinetica::new(vec!["http://localhost:9191".to_string()], options).await?
);
let record_type = Arc::new(Type::from_table(&kinetica, "my_table").await?);

let retriever = RecordRetriever::new(kinetica, "my_table", record_type).await?;

Creates a retriever passing options to its retrievals.

Creates a retriever with the given worker list.

None derives the list from the connection’s own worker addresses, which is the default; an empty list (WorkerList::empty) declines multi-head for this retriever.

Creates a retriever with the given worker list and options.

Creates a retriever returning records decoded as T, from the Avro schema of record_type. workers and options are as for RecordRetriever::with_options.

use gpudb_api::{Kinetica, KineticaOptions, RecordRetriever, ShardKeyValue, Type};
use std::sync::Arc;

#[derive(serde::Deserialize)]
struct Row {
    id: i32,
    name: Option<String>,
}

let record_type = Arc::new(Type::from_table(&kinetica, "my_table").await?);
let retriever = RecordRetriever::<Row>::new_typed(kinetica, "my_table", record_type, None, None).await?;
let rows: Vec<Row> = retriever.get_by_key(&[ShardKeyValue::Int(1)], None).await?.data;

Gets the connection from which records will be retrieved.

Gets the name of the table from which records will be retrieved.

Returns whether this RecordRetriever is using the head rank for simple record fetching (not utilizing the server’s key lookup feature).

Returns whether this RecordRetriever is using worker ranks for key lookups.

Gets the options currently used for the retriever methods.

Sets the options to be used for the retriever methods.

Retrieves records with the given key values and filter expression.

This method operates in four modes, depending on the parameters passed:

• key values only: attempts a direct-to-rank lookup for records matching the given key values
• key values and expression: attempts a direct-to-rank lookup for records matching the given key values, filtering them by the given expression
• expression only: requests, via the head rank, all records in the table matching the given filter expression
• neither: retrieves all records from the table via the head rank

• key_values - The key values to use for the lookup, one per key column in key order, or none; these must correspond to either the explicit or implicit shard key for sharded tables or the primary key of replicated tables. Each must be of a type its column takes (see RecordKeyBuilder::build_expression).
• expression - A filter expression that will be applied to the data requested by the key values; if no key values are specified this filter will be applied to all of the data in the target table

The requested records, decoded.

Retrieves records with the given key values and filter expression, starting from an offset.

• key_values - The key values to use for the lookup, or none
• expression - A filter expression
• offset - Offset of the record(s) within the result set to return

The requested records, decoded.

Retrieves specific columns with the given key values and filter expression.

• columns - The requested columns (which can include expressions). May use “*” for all columns.
• key_values - The key values to use for the lookup, or none
• expression - A filter expression

The requested records, typed by the response.

Retrieves specific columns with the given key values and filter expression, starting from an offset.

• columns - The requested columns
• key_values - The key values to use for the lookup, or none
• expression - A filter expression
• offset - Offset of the record(s) within the result set to return

The requested records, typed by the response.