Struct Config

pub struct Config {
    pub url: String,
    pub min_connections: Option<u32>,
    pub max_connections: usize,
    pub connect_timeout: u64,
    pub idle_timeout: Option<u64>,
    pub extensions: Option<Vec<String>>,
}

Base configuration for all database drivers.

A dictionary matching this structure is extracted from the active Figment, scoped to databases.name, where name is the name of the database, by the Initializer fairing on ignition and used to configure the relevant database and database pool.

With the default provider, these parameters are typically configured in a Rocket.toml file:

[default.databases.db_name]
url = "/path/to/db.sqlite"

# Only `url` is required. These have sane defaults and are optional.
min_connections = 64
max_connections = 1024
connect_timeout = 5
idle_timeout = 120

# This option is only supported by the `sqlx_sqlite` driver.
extensions = ["memvfs", "rot13"]

Alternatively, a custom provider can be used. For example, a custom Figment with a global databases.name configuration:

#[launch]
fn rocket() -> _ {
    let figment = rocket::Config::figment()
        .merge(("databases.name", rocket_db_pools::Config {
            url: "db:specific@config&url".into(),
            min_connections: None,
            max_connections: 1024,
            connect_timeout: 3,
            idle_timeout: None,
            extensions: None,
        }));

    rocket::custom(figment)
}

For general information on configuration in Rocket, see rocket::config. For higher-level details on configuring a database, see the crate-level docs.

Fields

url: String

Database-specific connection and configuration URL.

The format of the URL is database specific; consult your database’s documentation.

min_connections: Option<u32>

Minimum number of connections to maintain in the pool.

Note: deadpool drivers do not support and thus ignore this value.

Default: None.

max_connections: usize

Maximum number of connections to maintain in the pool.

Default: workers * 4.

connect_timeout: u64

Number of seconds to wait for a connection before timing out.

If the timeout elapses before a connection can be made or retrieved from a pool, an error is returned.

Default: 5.

idle_timeout: Option<u64>

Maximum number of seconds to keep a connection alive for.

After a connection is established, it is maintained in a pool for efficient connection retrieval. When an idle_timeout is set, that connection will be closed after the timeout elapses. If an idle_timeout is not specified, the behavior is driver specific but typically defaults to keeping a connection active indefinitely.

Default: None.

extensions: Option<Vec<String>>

A list of database extensions to load at run-time.

Note: Only the sqlx_sqlite driver supports this option (for SQLite extensions) at this time. All other drivers ignore this option.

Default: None.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>( __deserializer: __D, ) -> Result<Config, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

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

const 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 Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config