Trait bonsaidb_core::connection::StorageConnection
source · pub trait StorageConnection: HasSession + Sized + Send + Sync {
type Database: Connection;
type Authenticated: StorageConnection;
Show 16 methods
fn admin(&self) -> Self::Database;
fn database<DB: Schema>(&self, name: &str) -> Result<Self::Database, Error>;
fn create_database_with_schema(
&self,
name: &str,
schema: SchemaName,
only_if_needed: bool
) -> Result<(), Error>;
fn delete_database(&self, name: &str) -> Result<(), Error>;
fn list_databases(&self) -> Result<Vec<Database>, Error>;
fn list_available_schemas(&self) -> Result<Vec<SchemaName>, Error>;
fn create_user(&self, username: &str) -> Result<u64, Error>;
fn delete_user<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U
) -> Result<(), Error>;
fn set_user_password<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U,
password: SensitiveString
) -> Result<(), Error>;
fn authenticate<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U,
authentication: Authentication
) -> Result<Self::Authenticated, Error>;
fn assume_identity(
&self,
identity: IdentityReference<'_>
) -> Result<Self::Authenticated, Error>;
fn add_permission_group_to_user<'user, 'group, U: Nameable<'user, u64> + Send + Sync, G: Nameable<'group, u64> + Send + Sync>(
&self,
user: U,
permission_group: G
) -> Result<(), Error>;
fn remove_permission_group_from_user<'user, 'group, U: Nameable<'user, u64> + Send + Sync, G: Nameable<'group, u64> + Send + Sync>(
&self,
user: U,
permission_group: G
) -> Result<(), Error>;
fn add_role_to_user<'user, 'role, U: Nameable<'user, u64> + Send + Sync, R: Nameable<'role, u64> + Send + Sync>(
&self,
user: U,
role: R
) -> Result<(), Error>;
fn remove_role_from_user<'user, 'role, U: Nameable<'user, u64> + Send + Sync, R: Nameable<'role, u64> + Send + Sync>(
&self,
user: U,
role: R
) -> Result<(), Error>;
fn create_database<DB: Schema>(
&self,
name: &str,
only_if_needed: bool
) -> Result<Self::Database, Error> { ... }
}
Expand description
Functions for interacting with a multi-database BonsaiDb instance.
Required Associated Types§
sourcetype Database: Connection
type Database: Connection
The type that represents a database for this implementation.
sourcetype Authenticated: StorageConnection
type Authenticated: StorageConnection
The StorageConnection
type returned from authentication calls.
Required Methods§
sourcefn database<DB: Schema>(&self, name: &str) -> Result<Self::Database, Error>
fn database<DB: Schema>(&self, name: &str) -> Result<Self::Database, Error>
Returns a reference to database name
with schema DB
.
sourcefn create_database_with_schema(
&self,
name: &str,
schema: SchemaName,
only_if_needed: bool
) -> Result<(), Error>
fn create_database_with_schema(
&self,
name: &str,
schema: SchemaName,
only_if_needed: bool
) -> Result<(), Error>
Creates a database named name
using the SchemaName
schema
.
Errors
Error::InvalidDatabaseName
:name
must begin with an alphanumeric character ([a-zA-Z0-9]
), and all remaining characters must be alphanumeric, a period (.
), or a hyphen (-
).Error::DatabaseNameAlreadyTaken
:name
was already used for a previous database name. Database names are case insensitive. Returned ifonly_if_needed
is false.
sourcefn delete_database(&self, name: &str) -> Result<(), Error>
fn delete_database(&self, name: &str) -> Result<(), Error>
Deletes a database named name
.
Errors
Error::DatabaseNotFound
: databasename
does not exist.Error::Io
: an error occurred while deleting files.
sourcefn list_available_schemas(&self) -> Result<Vec<SchemaName>, Error>
fn list_available_schemas(&self) -> Result<Vec<SchemaName>, Error>
Lists the SchemaName
s registered with this storage.
sourcefn delete_user<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U
) -> Result<(), Error>
fn delete_user<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U
) -> Result<(), Error>
Deletes a user.
sourcefn set_user_password<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U,
password: SensitiveString
) -> Result<(), Error>
fn set_user_password<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U,
password: SensitiveString
) -> Result<(), Error>
Sets a user’s password.
sourcefn authenticate<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U,
authentication: Authentication
) -> Result<Self::Authenticated, Error>
fn authenticate<'user, U: Nameable<'user, u64> + Send + Sync>(
&self,
user: U,
authentication: Authentication
) -> Result<Self::Authenticated, Error>
Authenticates as a user with a authentication method.
sourcefn assume_identity(
&self,
identity: IdentityReference<'_>
) -> Result<Self::Authenticated, Error>
fn assume_identity(
&self,
identity: IdentityReference<'_>
) -> Result<Self::Authenticated, Error>
Assumes the identity
. If successful, the returned instance will have
the merged permissions of the current authentication session and the
permissions from identity
.
sourcefn add_permission_group_to_user<'user, 'group, U: Nameable<'user, u64> + Send + Sync, G: Nameable<'group, u64> + Send + Sync>(
&self,
user: U,
permission_group: G
) -> Result<(), Error>
fn add_permission_group_to_user<'user, 'group, U: Nameable<'user, u64> + Send + Sync, G: Nameable<'group, u64> + Send + Sync>(
&self,
user: U,
permission_group: G
) -> Result<(), Error>
Adds a user to a permission group.
sourcefn remove_permission_group_from_user<'user, 'group, U: Nameable<'user, u64> + Send + Sync, G: Nameable<'group, u64> + Send + Sync>(
&self,
user: U,
permission_group: G
) -> Result<(), Error>
fn remove_permission_group_from_user<'user, 'group, U: Nameable<'user, u64> + Send + Sync, G: Nameable<'group, u64> + Send + Sync>(
&self,
user: U,
permission_group: G
) -> Result<(), Error>
Removes a user from a permission group.
Provided Methods§
sourcefn create_database<DB: Schema>(
&self,
name: &str,
only_if_needed: bool
) -> Result<Self::Database, Error>
fn create_database<DB: Schema>(
&self,
name: &str,
only_if_needed: bool
) -> Result<Self::Database, Error>
Creates a database named name
with the Schema
provided.
Errors
Error::InvalidDatabaseName
:name
must begin with an alphanumeric character ([a-zA-Z0-9]
), and all remaining characters must be alphanumeric, a period (.
), or a hyphen (-
).Error::DatabaseNameAlreadyTaken
:name
was already used for a previous database name. Database names are case insensitive. Returned ifonly_if_needed
is false.