Skip to main content

PoolConfig

Struct PoolConfig 

Source
#[non_exhaustive]
pub struct PoolConfig { pub max_connections: usize, pub min_connections: usize, pub connection_timeout: Option<Duration>, pub idle_timeout: Option<Duration>, pub recycle_timeout: Option<Duration>, pub max_lifetime: Option<Duration>, pub recycling: PgRecycling, pub statement_cache_size: usize, }
Expand description

Configuration for the connection pool.

Fields (Non-exhaustive)§

This struct is marked as 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.
§max_connections: usize

Maximum number of connections in the pool.

§min_connections: usize

Minimum number of connections to pre-establish and keep alive.

deadpool exposes no minimum-size knob, so these are established by a best-effort background warmup when the pool is created; the released connections are then retained by the pool.

§connection_timeout: Option<Duration>

Maximum time to wait for a connection.

§idle_timeout: Option<Duration>

Idle timeout: a connection that was not handed out for longer than this is discarded and replaced at its next checkout instead of being reused (so a connection a server, proxy or NAT may have dropped while idle is not handed out).

Enforced at checkout, like max_lifetime: idle connections are not reaped in the background. The idle time is measured from when the connection was last handed out (deadpool does not record when it is returned), so a connection held for longer than this is also replaced at its next checkout. Duration::ZERO replaces every reused connection; None disables the limit. It does not bound the recycle check; use PoolConfig::recycle_timeout for that. Default: 10 minutes.

§recycle_timeout: Option<Duration>

Upper bound on the recycle check run when a connection is checked out again (the Verified / Clean round trip).

Mapped to deadpool’s recycle_timeout. A recycle that exceeds it discards the connection and a fresh one is created. None disables the bound. Default: 5 seconds.

§max_lifetime: Option<Duration>

Maximum lifetime of a connection.

Enforced at checkout: a connection older than this is discarded and replaced instead of being handed out. Connections are not reaped while idle. Each connection’s limit is shortened by a stable jitter of up to ~10% so connections created together do not all expire at once. Duration::ZERO replaces the connection on every checkout, which effectively disables pooling.

§recycling: PgRecycling

Recycling method applied when a connection is checked out again.

Defaults to PgRecycling::Fast, which does not reset session state (SET, SET ROLE, tenant GUCs persist across checkouts). Use PgRecycling::Clean for RLS / tenant-scoped workloads.

§statement_cache_size: usize

Number of SQL strings tracked for prepared-statement cache metrics.

PreparedStatementCache records only which SQL strings have been seen (hit/miss tracing); actual statement caching is per-connection inside tokio-postgres and is not bounded by this value.

Trait Implementations§

Source§

impl Clone for PoolConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PoolConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PoolConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more