Struct sqlx_core::pool::Pool

pub struct Pool<C>(_);

A pool of database connections.

Methods

impl<C> Pool<C> where
    C: Connect, 

pub async fn new<'_>(url: &'_ str) -> Result<Self>

Creates a connection pool with the default configuration.

The connection URL syntax is documented on the connection type for the respective database you're connecting to:

• MySQL/MariaDB: [crate::mysql::MySqlConnection]
• PostgreSQL: [crate::postgres::PgConnection]

pub fn builder() -> Builder<C>

Returns a Builder to configure a new connection pool.

pub async fn acquire<'_>(&'_ self) -> Result<PoolConnection<C>>

Retrieves a connection from the pool.

Waits for at most the configured connection timeout before returning an error.

pub fn try_acquire(&self) -> Option<PoolConnection<C>>

Attempts to retrieve a connection from the pool if there is one available.

Returns None immediately if there are no idle connections available in the pool.

pub async fn begin<'_>(&'_ self) -> Result<Transaction<PoolConnection<C>>>

Retrieves a new connection and immediately begins a new transaction.

pub async fn close<'_>(&'_ self)

Ends the use of a connection pool. Prevents any new connections and will close all active connections when they are returned to the pool.

Does not resolve until all connections are closed.

pub fn is_closed(&self) -> bool

Returns true if .close() has been called on the pool, false otherwise.

pub fn size(&self) -> u32

Returns the number of connections currently being managed by the pool.

pub fn idle(&self) -> usize

Returns the number of idle connections.

pub fn max_size(&self) -> u32

Returns the configured maximum pool size.

pub fn connect_timeout(&self) -> Duration

Returns the maximum time spent acquiring a new connection before an error is returned.

pub fn min_size(&self) -> u32

Returns the configured minimum idle connection count.

pub fn max_lifetime(&self) -> Option<Duration>

Returns the configured maximum connection lifetime.

pub fn idle_timeout(&self) -> Option<Duration>

Returns the configured idle connection timeout.

Trait Implementations

impl<C> Clone for Pool<C>

Returns a new Pool tied to the same shared connection pool.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Pool<C> where
    C: Connect, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'p, C, DB> Executor for &'p Pool<C> where
    C: Connect<Database = DB>,
    DB: Database<Connection = C>,
    DB: for<'c, 'q> HasCursor<'c, 'q, Database = DB>, 

type Database = DB

The specific database that this type is implemented for.

fn execute<'e, 'q: 'e, 'c: 'e, E: 'e>(
    &'c mut self,
    query: E
) -> BoxFuture<'e, Result<u64>> where
    E: Execute<'q, Self::Database>, 

Executes the query for its side-effects and discarding any potential result rows.

fn fetch<'e, 'q, E>(
    &'e mut self,
    query: E
) -> <Self::Database as HasCursor<'_, 'q>>::Cursor where
    E: Execute<'q, DB>, 

Executes a query for its result.

impl<'p, C, DB> RefExecutor<'p> for &'p Pool<C> where
    C: Connect<Database = DB>,
    DB: Database<Connection = C>,
    DB: for<'c, 'q> HasCursor<'c, 'q>,
    &'c mut C: RefExecutor<'c>, 

type Database = DB

fn fetch_by_ref<'q, E>(
    self,
    query: E
) -> <Self::Database as HasCursor<'p, 'q>>::Cursor where
    E: Execute<'q, DB>,