Enum DatabaseConfiguration

pub enum DatabaseConfiguration {
    SqlitePersistent {
        path: PathBuf,
        single_connection: bool,
    },
    SqliteInMemory {
        single_connection: bool,
    },
    Postgres {
        host: String,
        port: u16,
        database_name: String,
        user: Option<DatabaseUser>,
    },
}

Configuration for the database. We either use Sqlite or Postgres

Variants

SqlitePersistent

Configuration for a SQLite database

Fields

path: PathBuf

Database file path if the database is stored on disk

single_connection: bool

Set the connection pool size to 1, needed for the initial migration

SqliteInMemory

Configuration for a SQLite database

Fields

single_connection: bool

Set the connection pool size to 1, needed for the initial migration

Postgres

Configuration for a Postgres database

Fields

host: String

Database host name

port: u16

Database host port

database_name: String

Database name

user: Option<DatabaseUser>

Database user

Implementations

impl DatabaseConfiguration

pub fn postgres() -> Result<Option<DatabaseConfiguration>>

Create a postgres database configuration from environment variables.

At minima, the database host and port must be provided.

pub fn sqlite(path: &Path) -> DatabaseConfiguration

Create a local sqlite configuration

pub fn sqlite_in_memory() -> DatabaseConfiguration

Create an in-memory sqlite configuration

pub fn single_connection(&self) -> Self

Create a single connection sqlite configuration

pub fn database_type(&self) -> DatabaseType

Return the type of database that has been configured

pub fn connection_string(&self) -> String

Return the type of database that has been configured

pub fn create_directory_if_necessary(&self) -> Result<()>

Create a directory for the SQLite database file if necessary

pub fn exists(&self) -> bool

Return true if the path for a SQLite database exists

pub fn path(&self) -> Option<PathBuf>

Return the database path if the database is a SQLite file.

Trait Implementations

impl Clone for DatabaseConfiguration

fn clone(&self) -> DatabaseConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseConfiguration

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

Formats the value using the given formatter.

impl PartialEq for DatabaseConfiguration

fn eq(&self, other: &DatabaseConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DatabaseConfiguration

impl StructuralPartialEq for DatabaseConfiguration