Skip to main content

PgPoolConfig

Struct PgPoolConfig 

Source
pub struct PgPoolConfig {
    pub max_size: usize,
    pub min_size: usize,
    pub max_lifetime: Option<Duration>,
    pub idle_timeout: Option<Duration>,
    pub checkout_timeout: Option<Duration>,
    pub connection_timeout: Option<Duration>,
    pub test_on_checkout: bool,
    pub validation_query: String,
    pub auto_reconnect: bool,
}
Expand description

Pool configuration options.

Fields§

§max_size: usize

Maximum number of connections in this pool.

§min_size: usize

Minimum number of connections to maintain (eagerly created).

§max_lifetime: Option<Duration>

Maximum lifetime of a connection before it is closed and recreated.

§idle_timeout: Option<Duration>

Close connections that have been idle for longer than this.

§checkout_timeout: Option<Duration>

Maximum time to wait when all connections are busy (get()).

§connection_timeout: Option<Duration>

Maximum time to wait when creating a new connection.

§test_on_checkout: bool

If true, run a validation query before returning a connection from the pool.

§validation_query: String

The query to use for validation (default: "SELECT 1").

§auto_reconnect: bool

If true, automatically reconnect when a connection is found to be dead.

Implementations§

Source§

impl PgPoolConfig

Source

pub fn new() -> Self

Create a new pool config with defaults.

Source

pub fn max_size(self, size: usize) -> Self

Set the maximum pool size.

Source

pub fn min_size(self, size: usize) -> Self

Set the minimum pool size.

Source

pub fn max_lifetime(self, duration: Duration) -> Self

Set the maximum connection lifetime.

Source

pub fn idle_timeout(self, duration: Duration) -> Self

Set the idle timeout.

Source

pub fn checkout_timeout(self, duration: Duration) -> Self

Set the checkout timeout (how long get() waits for a free connection).

Source

pub fn connection_timeout(self, duration: Duration) -> Self

Set the connection timeout.

Source

pub fn test_on_checkout(self, enable: bool) -> Self

Enable or disable test-on-checkout.

Source

pub fn no_max_lifetime(self) -> Self

Disable max lifetime.

Source

pub fn no_idle_timeout(self) -> Self

Disable idle timeout.

Trait Implementations§

Source§

impl Clone for PgPoolConfig

Source§

fn clone(&self) -> PgPoolConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PgPoolConfig

Source§

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

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

impl Default for PgPoolConfig

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, 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.