Struct Client 

pub struct Client { /* private fields */ }

A rust client for oomstore, using the grpc protocol to communicate with oomagent server under the hood.

Implementations

impl Client

pub async fn connect<D>(dst: D) -> Result<Self>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Connect to an oomagent instance running on the given endpoint.

pub async fn with_embedded_oomagent<P1, P2>( bin_path: Option<P1>, cfg_path: Option<P2>, ) -> Result<Self>

where P1: AsRef<Path>, P2: AsRef<Path>,

Connect to an oomagent instance embedded with the client.

pub async fn with_default_embedded_oomagent() -> Result<Self>

Connect to an embedded oomagent instance with default config.

pub async fn health_check(&mut self) -> Result<()>

Check if oomagent is ready to serve requests.

pub async fn online_get_raw( &mut self, entity_key: impl Into<String>, features: Vec<String>, ) -> Result<FeatureValueMap>

Get online features for an entity without further conversion.

pub async fn online_get( &mut self, key: impl Into<String>, features: Vec<String>, ) -> Result<HashMap<String, Option<Value>>>

Get online features for an entity.

pub async fn online_multi_get_raw( &mut self, entity_keys: Vec<String>, features: Vec<String>, ) -> Result<HashMap<String, FeatureValueMap>>

Get online features for multiple entities without further conversion.

pub async fn online_multi_get( &mut self, keys: Vec<String>, features: Vec<String>, ) -> Result<HashMap<String, HashMap<String, Option<Value>>>>

Get online features for multiple entities.

pub async fn sync( &mut self, group: impl Into<String>, revision_id: impl Into<Option<u32>>, purge_delay: u32, ) -> Result<()>

Sync a certain revision of batch features from offline to online store.

pub async fn channel_import( &mut self, group: impl Into<String>, revision: impl Into<Option<i64>>, description: impl Into<Option<String>>, rows: impl Stream<Item = Vec<u8>> + Send + 'static, ) -> Result<u32>

Import features from external (batch and stream) data sources to offline store through channels.

pub async fn import( &mut self, group: impl Into<String>, revision: impl Into<Option<i64>>, description: impl Into<Option<String>>, input_file: impl AsRef<Path>, delimiter: impl Into<Option<char>>, ) -> Result<u32>

Import features from external (batch and stream) data sources to offline store through files.

pub async fn push( &mut self, entity_key: impl Into<String>, group: impl Into<String>, kv_pairs: HashMap<String, Value>, ) -> Result<()>

Push stream features from stream data source to both offline and online stores.

pub async fn channel_join( &mut self, join_features: Vec<String>, existed_features: Vec<String>, entity_rows: impl Stream<Item = EntityRow> + Send + 'static, ) -> Result<(Vec<String>, impl Stream<Item = Result<Vec<Option<Value>>>>)>

Point-in-Time Join features against labeled entity rows through channels.

pub async fn join( &mut self, features: Vec<String>, input_file: impl AsRef<Path>, output_file: impl AsRef<Path>, ) -> Result<()>

Point-in-Time Join features against labeled entity rows through files.

pub async fn channel_export( &mut self, features: Vec<String>, unix_milli: u64, limit: impl Into<Option<usize>>, ) -> Result<(Vec<String>, impl Stream<Item = Result<Vec<Option<Value>>>>)>

Export certain features to a channel.

pub async fn export( &mut self, features: Vec<String>, unix_milli: u64, output_file: impl AsRef<Path>, limit: impl Into<Option<usize>>, ) -> Result<()>

Export certain features to a file.

pub async fn snapshot(&mut self, group: impl Into<String>) -> Result<()>

Take snapshot for a stream feature group in offline store.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.