Struct datacake_sqlite::StorageHandle

pub struct StorageHandle { /* private fields */ }

A asynchronous wrapper around a SQLite database.

These operations will be ran in a background thread preventing any IO operations from blocking the async context.

Implementations

impl StorageHandle

pub async fn open(path: impl AsRef<Path>) -> Result<Self>

Connects to the SQLite database.

This spawns 1 background threads with actions being executed within that thread.

This approach reduces the affect of writes blocking reads and vice-versa.

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

Connects to a new in-memory SQLite database.

pub async fn execute<P>(&self, sql: impl AsRef<str>, params: P) -> Result<usize>where
    P: Params + Clone + Send + 'static,

Execute a SQL statement with some provided parameters.

pub async fn execute_many<P>(
    &self,
    sql: impl AsRef<str>,
    param_set: Vec<P>
) -> Result<usize>where
    P: Params + Clone + Send + 'static,

Execute a SQL statement several times with some provided parameters.

The statement is executed within the same transaction.

pub async fn fetch_one<P, T>(
    &self,
    sql: impl AsRef<str>,
    params: P
) -> Result<Option<T>>where
    P: Params + Send + 'static,
    T: FromRow + Send + 'static,

Fetch a single row from a given SQL statement with some provided parameters.

pub async fn fetch_many<P, T>(
    &self,
    sql: impl AsRef<str>,
    param_sets: Vec<P>
) -> Result<Vec<T>>where
    P: Params + Send + 'static,
    T: FromRow + Send + 'static,

Fetch a many rows by executing the same statement on several sets of parameters.

pub async fn fetch_all<P, T>(
    &self,
    sql: impl AsRef<str>,
    params: P
) -> Result<Vec<T>>where
    P: Params + Send + 'static,
    T: FromRow + Send + 'static,

Fetch a all rows from a given SQL statement with some provided parameters.

Trait Implementations

impl Clone for StorageHandle

fn clone(&self) -> StorageHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageHandle

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

Formats the value using the given formatter.