Struct DatabaseConfig

pub struct DatabaseConfig {
    pub host: String,
    pub port: u16,
    pub username: String,
    pub password: String,
    pub database: String,
    pub max_open_cons: u32,
    pub min_idle_cons: u32,
    pub conn_max_lifetime: Duration,
    pub connection_timeout: Duration,
    pub idle_timeout: Duration,
}

DatabaseConfig represents the configuration for connecting to a database.

This configuration object can be used to set up a connection pool to PostgreSQL or another sqlx-supported database.

Configuration fields can be loaded from various sources, such as YAML, JSON configuration files, or from environment variables.

Example configuration in YAML:

host: localhost
port: 5432
username: user
password: password
database: test
max_open_cons: 10
min_idle_cons: 5
conn_max_lifetime:
  secs: 900
  nanos: 0
connection_timeout:
  secs: 15
  nanos: 0
idle_timeout:
  secs: 3600
  nanos: 0

Fields

host: String

The database host address (e.g. localhost).

port: u16

The port to connect to the database (e.g. 5432 for PostgreSQL).

username: String

The username to connect to the database.

password: String

The password to connect to the database.

database: String

The name of the database to connect to.

max_open_cons: u32

The maximum number of open connections in the pool.

min_idle_cons: u32

The minimum number of idle connections in the pool.

conn_max_lifetime: Duration

The maximum connection lifetime.

connection_timeout: Duration

The timeout for getting a connection from the pool.

idle_timeout: Duration

The idle connection timeout in the pool, after which the connection can be closed.

Trait Implementations

impl Debug for DatabaseConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DatabaseConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DatabaseConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.