Struct akd::storage::manager::StorageManager

pub struct StorageManager<Db: Database + Sync + Send> {
    pub db: Db,
    /* private fields */
}

Represents the manager of the storage mediums, including caching and transactional operations (creating the transaction, commiting it, etc)

Fields

db: Db

The underlying database managed by this storage manager

Implementations

impl<Db: Database + Sync + Send> StorageManager<Db>

pub fn new_no_cache(db: &Db) -> Self

Create a new storage manager with NO CACHE

pub fn new(
    db: &Db,
    cache_item_lifetime: Option<Duration>,
    cache_limit_bytes: Option<usize>,
    cache_clean_frequency: Option<Duration>
) -> Self

Create a new storage manager with a cache utilizing the options provided (or defaults)

pub async fn log_metrics(&self, level: Level)

Log metrics from the storage manager (cache, transaction, and storage hit rates etc)

pub async fn begin_transaction(&self) -> bool

Start an in-memory transaction of changes

pub async fn commit_transaction(&self) -> Result<(), StorageError>

Commit a transaction in the database

pub async fn rollback_transaction(&self) -> Result<(), StorageError>

Rollback a transaction

pub async fn is_transaction_active(&self) -> bool

Retrieve a flag determining if there is a transaction active

pub async fn set(&self, record: DbRecord) -> Result<(), StorageError>

Store a record in the database

pub async fn batch_set(&self, records: Vec<DbRecord>) -> Result<(), StorageError>

Set a batch of records in the database

pub async fn get_direct<St: Storable>(
    &self,
    id: &St::StorageKey
) -> Result<DbRecord, StorageError>

Retrieve a stored record directly from the data layer, ignoring any caching or transaction processes

pub async fn get<St: Storable>(
    &self,
    id: &St::StorageKey
) -> Result<DbRecord, StorageError>

Retrieve a stored record from the database

pub async fn batch_get<St: Storable>(
    &self,
    ids: &[St::StorageKey]
) -> Result<Vec<DbRecord>, StorageError>

Retrieve a batch of records by id from the database

pub async fn flush_cache(&self)

Flush the caching of objects (if present)

pub async fn tombstone_value_states(
    &self,
    keys: &[ValueStateKey]
) -> Result<(), StorageError>

Tombstone a set of records adhereing to the caching + transactional settings of the storage manager

pub async fn get_user_state(
    &self,
    username: &AkdLabel,
    flag: ValueStateRetrievalFlag
) -> Result<ValueState, StorageError>

Retrieve the specified user state object based on the retrieval flag from the database

pub async fn get_user_data(
    &self,
    username: &AkdLabel
) -> Result<KeyData, StorageError>

Retrieve all values states for a given user

pub async fn get_user_state_versions(
    &self,
    usernames: &[AkdLabel],
    flag: ValueStateRetrievalFlag
) -> Result<HashMap<AkdLabel, (u64, AkdValue)>, StorageError>

Retrieve the user -> state version mapping in bulk. This is the same as get_user_state in a loop, but with less data retrieved from the storage layer

Trait Implementations

impl<Db: Database + Sync + Send> Clone for StorageManager<Db>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Db: Database + Sync + Send> Send for StorageManager<Db>

impl<Db: Database + Sync + Send> Sync for StorageManager<Db>