Struct AsyncMySqlDatabase

pub struct AsyncMySqlDatabase { /* private fields */ }

Represents an asynchronous connection to a MySQL database

Implementations

impl<'a> AsyncMySqlDatabase

pub async fn new<T: Into<String>>( endpoint: T, database: T, user: Option<T>, password: Option<T>, port: Option<u16>, depth: usize, ) -> Result<Self, StorageError>

Creates a new mysql database

pub async fn is_healthy(&self) -> bool

Determine if the db connection is healthy at present

pub async fn delete_data(&self) -> Result<(), Error>

Delete all the data in the tables

pub async fn drop_tables(&self) -> Result<(), Error>

Drop all the tables

pub async fn create_test_db<T: Into<String>>( endpoint: T, user: Option<T>, password: Option<T>, port: Option<u16>, ) -> Result<(), Error>

Create the test database

pub fn test_guard() -> bool

Determine if the MySQL environment is available for execution (i.e. docker container is running)

Trait Implementations

impl Clone for AsyncMySqlDatabase

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Database for AsyncMySqlDatabase

fn set<'life0, 'async_trait>( &'life0 self, record: DbRecord, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Storage a record in the data layer

fn get<'life0, 'life1, 'async_trait, St>( &'life0 self, id: &'life1 St::StorageKey, ) -> Pin<Box<dyn Future<Output = Result<DbRecord, StorageError>> + Send + 'async_trait>>

where St: 'async_trait + Storable, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a stored record from the data layer

fn batch_get<'life0, 'life1, 'async_trait, St>( &'life0 self, ids: &'life1 [St::StorageKey], ) -> Pin<Box<dyn Future<Output = Result<Vec<DbRecord>, StorageError>> + Send + 'async_trait>>

where St: 'async_trait + Storable, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a batch of records by id

fn batch_set<'life0, 'async_trait>( &'life0 self, records: Vec<DbRecord>, _state: DbSetState, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set multiple records in the database with a minimal set of operations

fn get_user_data<'life0, 'life1, 'async_trait>( &'life0 self, username: &'life1 AkdLabel, ) -> Pin<Box<dyn Future<Output = Result<KeyData, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve the user data for a given user

fn get_user_state<'life0, 'life1, 'async_trait>( &'life0 self, username: &'life1 AkdLabel, flag: ValueStateRetrievalFlag, ) -> Pin<Box<dyn Future<Output = Result<ValueState, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a specific state for a given user

fn get_user_state_versions<'life0, 'life1, 'async_trait>( &'life0 self, keys: &'life1 [AkdLabel], flag: ValueStateRetrievalFlag, ) -> Pin<Box<dyn Future<Output = Result<HashMap<AkdLabel, (u64, AkdValue)>, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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

impl Display for AsyncMySqlDatabase

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

Formats the value using the given formatter.