Struct ockam_node::storage::database::SqlxDatabase

pub struct SqlxDatabase {
    pub pool: Arc<SqlitePool>,
    pub node_name: Option<String>,
}

The SqlxDatabase struct is used to create a database:

• at a given path
• with a given schema / or migrations applied to an existing schema

We use sqlx as our primary interface for interacting with the database The database driver is currently Sqlite

Fields

pool: Arc<SqlitePool>

Pool of connections to the database

node_name: Option<String>

Node name to isolate data between nodes where needed

Implementations

impl SqlxDatabase

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

Constructor for a database persisted on disk

pub async fn create_with_migration( path: impl AsRef<Path>, migration_set: impl MigrationSet ) -> Result<Self>

Constructor for a database persisted on disk, with a specific schema / migration

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

Constructor for a database persisted on disk without migration

pub async fn create_with_node_name( path: impl AsRef<Path>, node_name: &str ) -> Result<Self>

Constructor for a database persisted on disk, passing a node name to isolate data between nodes where needed

pub async fn in_memory(usage: &str) -> Result<Self>

Create a nodes database in memory => this database is deleted on an ockam reset command! (contrary to the application database below)

pub async fn application_in_memory(usage: &str) -> Result<Self>

Create an application database in memory The application database which contains the application configurations => this database is NOT deleted on an ockam reset command!

pub async fn in_memory_with_migration( usage: &str, migration_set: impl MigrationSet ) -> Result<Self>

Create an in-memory database with a specific migration

pub fn set_node_name(&mut self, node_name: &str)

Set the node name

pub fn node_name(&self) -> Result<String>

Return the node name

pub fn map_sql_err(err: Error) -> Error

Map a sqlx error into an ockam error

pub fn map_decode_err(err: Error) -> Error

Map a minicbor decode error into an ockam error

Trait Implementations

impl Clone for SqlxDatabase

fn clone(&self) -> SqlxDatabase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SqlxDatabase

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

Formats the value using the given formatter.

impl Deref for SqlxDatabase

type Target = Pool<Sqlite>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.