Struct sqlx::Pool

pub struct Pool<C>(_);

A pool of database connections.

Methods

impl<C> Pool<C> where
    C: Connection + Connect<Connection = C>, 

pub async fn new(url: &'_ str) -> Result<Pool<C>, Error>

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>, Error>

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>>, Error>

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) -> Pool<C>

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: Connection + Connect<Connection = C>, 

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

Formats the value using the given formatter.

impl<'_, C> Executor for &'_ Pool<C> where
    C: Connection + Connect<Connection = C>, 

type Database = <C as Executor>::Database

fn send<'e, 'q>(
    &'e mut self,
    commands: &'q str
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'e + Send>> where
    'q: 'e, 

Send a raw SQL command to the database.

fn execute<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <<C as Executor>::Database as Database>::Arguments
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + 'e + Send>> where
    'q: 'e, 

Execute the query, returning the number of rows affected.

fn fetch<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <<C as Executor>::Database as Database>::Arguments
) -> Pin<Box<dyn Stream<Item = Result<<<C as Executor>::Database as Database>::Row, Error>> + 'e + Send>> where
    'q: 'e, 

Executes the query and returns a [Stream] of [Row].

fn fetch_optional<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <<C as Executor>::Database as Database>::Arguments
) -> Pin<Box<dyn Future<Output = Result<Option<<<C as Executor>::Database as Database>::Row>, Error>> + 'e + Send>> where
    'q: 'e, 

Executes the query and returns up to resulting record.

fn describe<'e, 'q>(
    &'e mut self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<Describe<<&'_ Pool<C> as Executor>::Database>, Error>> + 'e + Send>> where
    'q: 'e, 

fn fetch_one<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <Self::Database as Database>::Arguments
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + 'e + Send>> where
    'q: 'e, 

Execute the query and return at most one resulting record.

impl<C> Executor for Pool<C> where
    C: Connection + Connect<Connection = C>, 

type Database = <C as Executor>::Database

fn send<'e, 'q>(
    &'e mut self,
    commands: &'q str
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'e + Send>> where
    'q: 'e, 

Send a raw SQL command to the database.

fn execute<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <<C as Executor>::Database as Database>::Arguments
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + 'e + Send>> where
    'q: 'e, 

Execute the query, returning the number of rows affected.

fn fetch<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <<C as Executor>::Database as Database>::Arguments
) -> Pin<Box<dyn Stream<Item = Result<<<C as Executor>::Database as Database>::Row, Error>> + 'e + Send>> where
    'q: 'e, 

Executes the query and returns a [Stream] of [Row].

fn fetch_optional<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <<C as Executor>::Database as Database>::Arguments
) -> Pin<Box<dyn Future<Output = Result<Option<<<C as Executor>::Database as Database>::Row>, Error>> + 'e + Send>> where
    'q: 'e, 

Executes the query and returns up to resulting record.

fn describe<'e, 'q>(
    &'e mut self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<Describe<<Pool<C> as Executor>::Database>, Error>> + 'e + Send>> where
    'q: 'e, 

fn fetch_one<'e, 'q>(
    &'e mut self,
    query: &'q str,
    args: <Self::Database as Database>::Arguments
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + 'e + Send>> where
    'q: 'e, 

Execute the query and return at most one resulting record.