Struct sqlx_core::pool::Builder

pub struct Builder<DB> where
    DB: Database,  { /* fields omitted */ }

Builder for Pool.

Methods

impl<DB> Builder<DB> where
    DB: Database, 

pub fn new() -> Self

Get a new builder with default options.

See the source of this method for current defaults.

pub fn max_size(self, max_size: u32) -> Self

Set the maximum number of connections that this pool should maintain.

pub fn connect_timeout(self, connect_timeout: Duration) -> Self

Set the amount of time to attempt connecting to the database.

If this timeout elapses, Pool::acquire will return an error.

pub fn min_size(self, min_size: u32) -> Self

Set the minimum number of connections to maintain at all times.

When the pool is built, this many connections will be automatically spun up.

If any connection is reaped by [max_lifetime] or [idle_timeout] and it brings the connection count below this amount, a new connection will be opened to replace it.

pub fn max_lifetime(self, max_lifetime: impl Into<Option<Duration>>) -> Self

Set the maximum lifetime of individual connections.

Any connection with a lifetime greater than this will be closed.

When set to None, all connections live until either reaped by [idle_timeout] or explicitly disconnected.

Infinite connections are not recommended due to the unfortunate reality of memory/resource leaks on the database-side. It is better to retire connections periodically (even if only once daily) to allow the database the opportunity to clean up data structures (parse trees, query metadata caches, thread-local storage, etc.) that are associated with a session.

pub fn idle_timeout(self, idle_timeout: impl Into<Option<Duration>>) -> Self

Set a maximum idle duration for individual connections.

Any connection with an idle duration longer than this will be closed.

For usage-based database server billing, this can be a cost saver.

pub async fn build<'_>(self, url: &'_ str) -> Result<Pool<DB>>

Spin up the connection pool.

If [min_size] was set to a non-zero value, that many connections will be immediately opened and placed into the pool.

Trait Implementations

impl<DB> Default for Builder<DB> where
    DB: Database, 

fn default() -> Self

Returns the "default value" for a type.