Struct PoolSettings 

pub struct PoolSettings {
    pub url: String,
    pub max_connections: u32,
    pub min_connections: u32,
    pub acquire_timeout: Duration,
    pub idle_timeout: Option<Duration>,
    pub max_lifetime: Option<Duration>,
    pub test_before_acquire: bool,
}

Connection-pool tuning resolved from the database.* configuration namespace.

Every field except url is optional in configuration and falls back to the same default sqlx itself uses, so an application that only sets database.url keeps sqlx’s well-chosen defaults. The recognised keys are:

Config key	Type	Default	Meaning
database.url	string	(required)	Connection string passed to sqlx.
database.max_connections	u32	10	Hard cap on open connections.
database.min_connections	u32	0	Connections kept warm when idle.
database.acquire_timeout_seconds	u64	30	How long acquire waits before erroring.
database.idle_timeout_seconds	u64	600	Reap idle connections after this long. 0 disables.
database.max_lifetime_seconds	u64	1800	Recycle connections older than this. 0 disables.
database.test_before_acquire	bool	true	Ping a connection before handing it out.

Fields

url: String

Database connection string (e.g. mysql://user:pass@host/db).

max_connections: u32

Maximum number of connections the pool will open.

min_connections: u32

Minimum number of connections kept open while the pool is idle.

acquire_timeout: Duration

Maximum time to wait when acquiring a connection from the pool.

idle_timeout: Option<Duration>

Close a connection after it has been idle for this long. None disables.

max_lifetime: Option<Duration>

Close a connection once it reaches this age. None disables.

test_before_acquire: bool

Whether to validate a connection (with a ping) before handing it out.

Implementations

impl PoolSettings

pub fn from_config() -> Self

Reads pool settings from the registered database configuration block.

Panics

Panics if database.url is not configured.

pub fn to_pool_options(&self) -> PoolOptions<Db>

Builds PoolOptions for the selected backend from these settings, without opening any connections.

Trait Implementations

impl Clone for PoolSettings

fn clone(&self) -> PoolSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolSettings

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

Formats the value using the given formatter.

impl Eq for PoolSettings

impl PartialEq for PoolSettings

fn eq(&self, other: &PoolSettings) -> 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 StructuralPartialEq for PoolSettings