Struct PgPool 

pub struct PgPool { /* private fields */ }

A connection pool for PostgreSQL.

Implementations

impl PgPool

pub async fn new(config: PgConfig) -> PgResult<Self>

Create a new connection pool from configuration.

pub async fn with_pool_config( config: PgConfig, pool_config: PoolConfig, ) -> PgResult<Self>

Create a new connection pool with custom pool configuration.

pub async fn get(&self) -> PgResult<PgConnection>

Get a connection from the pool.

pub fn status(&self) -> PoolStatus

Get the current pool status.

pub fn config(&self) -> &PgConfig

Get the pool configuration.

pub async fn is_healthy(&self) -> bool

Check if the pool is healthy by attempting to get a connection.

pub fn close(&self)

Close the pool and all connections.

pub fn builder() -> PgPoolBuilder

Create a builder for configuring the pool.

pub async fn warmup(&self, count: usize) -> PgResult<()>

Warm up the connection pool by pre-establishing connections.

This eliminates the latency of establishing connections on the first queries. The count parameter specifies how many connections to pre-establish.

Example

let pool = PgPool::builder()
    .url("postgresql://localhost/db")
    .max_connections(10)
    .build()
    .await?;

// Pre-establish 5 connections
pool.warmup(5).await?;

pub async fn warmup_with_statements( &self, count: usize, statements: &[&str], ) -> PgResult<()>

Warm up with common prepared statements.

This pre-prepares common SQL statements on warmed connections, eliminating the prepare latency on first use.

Trait Implementations

impl Clone for PgPool

fn clone(&self) -> PgPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.