Struct PoolConfig 

pub struct PoolConfig {
    pub endpoint: String,
    pub database: String,
    pub create_mode: CreateMode,
    pub user: Option<String>,
    pub password: Option<String>,
    pub max_size: usize,
    pub health_check: bool,
    pub after_connect: Option<AfterConnectHook>,
    pub before_acquire: Option<BeforeAcquireHook>,
}

Configuration for the connection pool.

Fields

endpoint: String

Server endpoint (e.g., “localhost:7483” or “http://localhost:7484”)

database: String

Database path

create_mode: CreateMode

Database creation mode (only used for first connection)

user: Option<String>

Optional username for authentication

password: Option<String>

Optional password for authentication

max_size: usize

Maximum number of connections in the pool

health_check: bool

If false, skip the per-checkout SELECT 1 health probe in recycle(). Defaults to true. Disable for hot paths where the roundtrip cost matters more than detecting a half-dead connection at acquire time. The pool still reaps connections via AsyncConnection::is_alive.

after_connect: Option<AfterConnectHook>

Optional hook run on every newly-opened connection (see AfterConnectHook).

before_acquire: Option<BeforeAcquireHook>

Optional hook run on every checkout (see BeforeAcquireHook).

Implementations

impl PoolConfig

pub fn new(endpoint: impl Into<String>, database: impl Into<String>) -> Self

Creates a new pool configuration.

pub fn create_mode(self, mode: CreateMode) -> Self

Sets the database creation mode.

pub fn auth(self, user: impl Into<String>, password: impl Into<String>) -> Self

Sets authentication credentials.

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

Sets the maximum pool size.

pub fn health_check(self, enabled: bool) -> Self

Enables or disables the per-checkout SELECT 1 health probe. Defaults to enabled. Disable on hot paths where the roundtrip cost outweighs the value of catching a dead connection at acquire time.

pub fn after_connect<F>(self, hook: F) -> Self

where F: Fn(&AsyncConnection) -> HookFuture<'_> + Send + Sync + 'static,

Installs a hook that runs on every newly-opened connection.

Use this to apply session-level setup (e.g. SET search_path, install prepared statements). The hook is called once per physical connection, not per checkout.

pub fn before_acquire<F>(self, hook: F) -> Self

where F: Fn(&AsyncConnection) -> HookFuture<'_> + Send + Sync + 'static,

Installs a hook that runs on every connection checkout, before the connection is handed to the caller.

Returning Err from the hook evicts the connection from the pool; the caller’s pool.get() then retries with another connection or builds a new one. Use this for per-acquire health checks beyond the default SELECT 1 probe (e.g. validating session state).

Trait Implementations

impl Clone for PoolConfig

fn clone(&self) -> PoolConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolConfig

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

Formats the value using the given formatter.