Struct Database

#[non_exhaustive]
pub struct Database {

    pub uri: Url,
    pub auto_migrate: bool,
    pub connect_timeout: Duration,
    pub connect_lazy: bool,
    pub acquire_timeout: Duration,
    pub idle_timeout: Option<Duration>,
    pub max_lifetime: Option<Duration>,
    pub min_connections: u32,
    pub max_connections: u32,
    pub test_on_checkout: bool,
    pub retry_connection: bool,
    pub temporary_test_db: bool,
    pub temporary_test_db_clean_up: bool,
    pub test_container: Option<TestContainer>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

uri: Url

This can be overridden with an environment variable, e.g. ROADSTER__DATABASE__URI=postgres://example:example@example:1234/example_app

auto_migrate: bool

Whether to automatically apply migrations during the app’s start up. Migrations can also be manually performed via the roadster migration [COMMAND] CLI command.

connect_timeout: Duration

connect_lazy: bool

Whether to attempt to connect to the DB immediately when the DB connection pool is created. If true will wait to connect to the DB until the first DB query is attempted.

acquire_timeout: Duration

idle_timeout: Option<Duration>

max_lifetime: Option<Duration>

min_connections: u32

max_connections: u32

test_on_checkout: bool

retry_connection: bool

See bb8_8::Builder::retry_connection

temporary_test_db: bool

Create a temporary database in the same DB host from the uri field.

temporary_test_db_clean_up: bool

Automatically clean up (drop) the temporary test DB that was created by setting temporary_test_db to true.

test_container: Option<TestContainer>

Options for creating a Test Container instance for the DB. If enabled, the Database#uri field will be overridden to be the URI for the Test Container instance that’s created when building the app’s crate::app::context::AppContext.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Database

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Database

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Database> for ConnectOptions

fn from(database: &Database) -> Self

Converts to this type from the input type.

impl From<Database> for ConnectOptions

fn from(database: Database) -> Self

Converts to this type from the input type.

impl Serialize for Database

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Database

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Database

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>