Struct bonsaidb::local::Storage

pub struct Storage { /* private fields */ }

A file-based, multi-database, multi-user database engine.

Implementations

impl Storage

pub async fn backup<L>(&'_ self, location: L) -> Result<(), Error> where
    L: AnyBackupLocation, 

Stores a copy of all data in this instance to location.

pub async fn restore<L>(&'_ self, location: L) -> Result<(), Error> where
    L: AnyBackupLocation, 

Stores a copy of all data in this instance to location.

impl Storage

pub async fn open(configuration: StorageConfiguration) -> Result<Storage, Error>

Creates or opens a multi-database Storage with its data stored in directory.

pub fn path(&self) -> &Path

Returns the path of the database storage.

pub fn unique_id(&self) -> StorageId

Returns the unique id of the server.

This value is set from the StorageConfiguration or randomly generated when creating a server. It shouldn’t be changed after a server is in use, as doing can cause issues. For example, the vault that manages encrypted storage uses the server ID to store the vault key. If the server ID changes, the vault key storage will need to be updated with the new server ID.

pub async fn register_schema<DB>(&'_ self) -> Result<(), Error> where
    DB: Schema, 

Registers a schema for use within the server.

pub async fn admin(&'_ self) -> Database

Returns the administration database.

Trait Implementations

impl Clone for Storage

pub fn clone(&self) -> Storage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Storage

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

Formats the value using the given formatter.

impl StorageConnection for Storage

type Database = Database

The type that represents a database for this implementation.

pub fn create_database_with_schema<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str,
    schema: SchemaName,
    only_if_needed: bool
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Storage: 'async_trait, 

Creates a database named name using the SchemaName schema.

pub fn database<'life0, 'life1, 'async_trait, DB>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<<Storage as StorageConnection>::Database, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    DB: Schema + 'async_trait,
    Storage: 'async_trait, 

Returns a reference to database name with schema DB.

pub fn delete_database<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Storage: 'async_trait, 

Deletes a database named name.

pub fn list_databases<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Database, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Storage: 'async_trait, 

Lists the databases in this storage.

pub fn list_available_schemas<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<SchemaName, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Storage: 'async_trait, 

Lists the SchemaNames registered with this storage.

pub fn create_user<'life0, 'life1, 'async_trait>(
    &'life0 self,
    username: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Storage: 'async_trait, 

Creates a user.

pub fn set_user_password<'user, 'life0, 'async_trait, U>(
    &'life0 self,
    user: U,
    password: SensitiveString
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'user: 'async_trait,
    'life0: 'async_trait,
    U: Into<NamedReference<'user>> + Send + Sync + 'async_trait,
    Storage: 'async_trait, 

Sets a user’s password.

pub fn authenticate<'user, 'life0, 'async_trait, U>(
    &'life0 self,
    user: U,
    authentication: Authentication
) -> Pin<Box<dyn Future<Output = Result<Authenticated, Error>> + Send + 'async_trait, Global>> where
    'user: 'async_trait,
    'life0: 'async_trait,
    U: Into<NamedReference<'user>> + Send + Sync + 'async_trait,
    Storage: 'async_trait, 

Authenticates as a user with a authentication method.

pub fn add_permission_group_to_user<'user, 'group, 'life0, 'async_trait, U, G>(
    &'life0 self,
    user: U,
    permission_group: G
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'user: 'async_trait,
    'group: 'async_trait,
    'life0: 'async_trait,
    U: Into<NamedReference<'user>> + Send + Sync + 'async_trait,
    G: Into<NamedReference<'group>> + Send + Sync + 'async_trait,
    Storage: 'async_trait, 

Adds a user to a permission group.

pub fn remove_permission_group_from_user<'user, 'group, 'life0, 'async_trait, U, G>(
    &'life0 self,
    user: U,
    permission_group: G
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'user: 'async_trait,
    'group: 'async_trait,
    'life0: 'async_trait,
    U: Into<NamedReference<'user>> + Send + Sync + 'async_trait,
    G: Into<NamedReference<'group>> + Send + Sync + 'async_trait,
    Storage: 'async_trait, 

Removes a user from a permission group.

pub fn add_role_to_user<'user, 'group, 'life0, 'async_trait, U, G>(
    &'life0 self,
    user: U,
    role: G
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'user: 'async_trait,
    'group: 'async_trait,
    'life0: 'async_trait,
    U: Into<NamedReference<'user>> + Send + Sync + 'async_trait,
    G: Into<NamedReference<'group>> + Send + Sync + 'async_trait,
    Storage: 'async_trait, 

Adds a user to a permission group.

pub fn remove_role_from_user<'user, 'group, 'life0, 'async_trait, U, G>(
    &'life0 self,
    user: U,
    role: G
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'user: 'async_trait,
    'group: 'async_trait,
    'life0: 'async_trait,
    U: Into<NamedReference<'user>> + Send + Sync + 'async_trait,
    G: Into<NamedReference<'group>> + Send + Sync + 'async_trait,
    Storage: 'async_trait, 

Removes a user from a permission group.

fn create_database<'life0, 'life1, 'async_trait, DB>(
    &'life0 self,
    name: &'life1 str,
    only_if_needed: bool
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    DB: Schema + 'async_trait,
    Self: 'async_trait, 

Creates a database named name with the Schema provided.