Struct sqlx::Pool

pub struct Pool<DB>(_)
 where
    DB: Database;

An asynchronous pool of SQLx database connections.

Create a pool with Pool::connect or Pool::connect_with and then call Pool::acquire to get a connection from the pool; when the connection is dropped it will return to the pool so it can be reused.

You can also pass &Pool directly anywhere an Executor is required; this will automatically checkout a connection for you.

See the module documentation for examples.

The pool has a maximum connection limit that it will not exceed; if acquire() is called when at this limit and all connections are checked out, the task will be made to wait until a connection becomes available.

You can configure the connection limit, and other parameters, using PoolOptions.

Calls to acquire() are fair, i.e. fulfilled on a first-come, first-serve basis.

Pool is Send, Sync and Clone, so it should be created once at the start of your application/daemon/web server/etc. and then shared with all tasks throughout its lifetime. How best to accomplish this depends on your program architecture.

In Actix-Web, you can share a single pool with all request handlers using web::Data.

Type aliases are provided for each database to make it easier to sprinkle Pool through your codebase:

• MssqlPool (MSSQL)
• MySqlPool (MySQL)
• PgPool (PostgreSQL)
• SqlitePool (SQLite)

Why Use a Pool?

A single database connection (in general) cannot be used by multiple threads simultaneously for various reasons, but an application or web server will typically need to execute numerous queries or commands concurrently (think of concurrent requests against a web server; many or all of them will probably need to hit the database).

You could place the connection in a Mutex but this will make it a huge bottleneck.

Naively, you might also think to just open a new connection per request, but this has a number of other caveats, generally due to the high overhead involved in working with a fresh connection. Examples to follow.

Connection pools facilitate reuse of connections to amortize these costs, helping to ensure that you’re not paying for them each time you need a connection.

1. Overhead of Opening a Connection

Opening a database connection is not exactly a cheap operation.

For SQLite, it means numerous requests to the filesystem and memory allocations, while for server-based databases it involves performing DNS resolution, opening a new TCP connection and allocating buffers.

Each connection involves a nontrivial allocation of resources for the database server, usually including spawning a new thread or process specifically to handle the connection, both for concurrency and isolation of faults.

Additionally, database connections typically involve a complex handshake including authentication, negotiation regarding connection parameters (default character sets, timezones, locales, supported features) and upgrades to encrypted tunnels.

If acquire() is called on a pool with all connections checked out but it is not yet at its connection limit (see next section), then a new connection is immediately opened, so this pool does not automatically save you from the overhead of creating a new connection.

However, because this pool by design enforces reuse of connections, this overhead cost is not paid each and every time you need a connection. In fact you set the min_connections option in PoolOptions, the pool will create that many connections up-front so that they are ready to go when a request comes in.

2. Connection Limits (MySQL, MSSQL, Postgres)

Database servers usually place hard limits on the number of connections that it allows open at any given time, to maintain performance targets and prevent excessive allocation of resources, namely RAM.

These limits have different defaults per database flavor, and may vary between different distributions of the same database, but are typically configurable on server start; if you’re paying for managed database hosting then the connection limit will typically vary with your pricing tier.

In MySQL, the default limit is typically 150, plus 1 which is reserved for a user with the CONNECTION_ADMIN privilege so you can still access the server to diagnose problems even with all connections being used.

In MSSQL the only documentation for the default maximum limit is that it depends on the version and server configuration.

In Postgres, the default limit is typically 100, minus 3 which are reserved for superusers (putting the default limit for unprivileged users at 97 connections).

In any case, exceeding these limits results in an error when opening a new connection, which in a web server context will turn into a 500 Internal Server Error if not handled, but should be turned into either 403 Forbidden or 429 Too Many Requests depending on your rate-limiting scheme. However, in a web context, telling a client “go away, maybe try again later” results in a sub-optimal user experience.

Instead with a connection pool, clients are made to wait in a fair queue for a connection to become available; by using a single connection pool for your whole application, you can ensure that you don’t exceed the connection limit of your database server while allowing response time to degrade gracefully at high load.

Of course, if multiple applications are connecting to the same database server, then you should ensure that the connection limits for all applications add up to your server’s maximum connections or less.

3. Resource Reuse

The first time you execute a query against your database, the database engine must first turn the SQL into an actionable query plan which it may then execute against the database. This involves parsing the SQL query, validating and analyzing it, and in the case of Postgres 12+ and SQLite, generating code to execute the query plan (native or bytecode, respectively).

These database servers provide a way to amortize this overhead by preparing the query, associating it with an object ID and placing its query plan in a cache to be referenced when it is later executed.

Prepared statements have other features, like bind parameters, which make them safer and more ergonomic to use as well. By design, SQLx pushes you towards using prepared queries/statements via the Query API et al. and the query!() macro et al., for reasons of safety, ergonomics, and efficiency.

However, because database connections are typically isolated from each other in the database server (either by threads or separate processes entirely), they don’t typically share prepared statements between connections so this work must be redone for each connection.

As with section 1, by facilitating reuse of connections, Pool helps to ensure their prepared statements (and thus cached query plans) can be reused as much as possible, thus amortizing the overhead involved.

Depending on the database server, a connection will have caches for all kinds of other data as well and queries will generally benefit from these caches being “warm” (populated with data).

Implementations

impl<DB> Pool<DB> where
    DB: Database, 

pub async fn connect(uri: &'_ str) -> Result<Pool<DB>, Error>

Creates a new connection pool with a default pool configuration and the given connection URI; and, immediately establishes one connection.

pub async fn connect_with(
    options: <<DB as Database>::Connection as Connection>::Options
) -> Result<Pool<DB>, Error>

Creates a new connection pool with a default pool configuration and the given connection options; and, immediately establishes one connection.

pub fn connect_lazy(uri: &str) -> Result<Pool<DB>, Error>

Creates a new connection pool with a default pool configuration and the given connection URI; and, will establish a connections as the pool starts to be used.

pub fn connect_lazy_with(
    options: <<DB as Database>::Connection as Connection>::Options
) -> Pool<DB>

Creates a new connection pool with a default pool configuration and the given connection options; and, will establish a connections as the pool starts to be used.

pub fn acquire(
    &self
) -> impl Future<Output = Result<PoolConnection<DB>, Error>> + 'static

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<DB>>

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<'static, DB>, Error>

Retrieves a new connection and immediately begins a new transaction.

pub async fn try_begin(
    &'_ self
) -> Result<Option<Transaction<'static, DB>>, Error>

Attempts to retrieve a new connection and immediately begins a new transaction if there is one available.

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 active. This includes idle connections.

pub fn num_idle(&self) -> usize

Returns the number of connections active and idle (not in use).

This will block until the number of connections stops changing for at least 2 atomic accesses in a row. If the number of idle connections is changing rapidly, this may run indefinitely.

Trait Implementations

impl<'a, '_, DB> Acquire<'a> for &'_ Pool<DB> where
    DB: Database, 

type Database = DB

type Connection = PoolConnection<DB>

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'_ Pool<DB> as Acquire<'a>>::Connection, Error>> + Send + 'static, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'a, DB>, Error>> + Send + 'static, Global>>

impl<DB> Clone for Pool<DB> where
    DB: Database, 

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

pub fn clone(&self) -> Pool<DB>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DB> Debug for Pool<DB> where
    DB: Database, 

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

Formats the value using the given formatter.

impl<'p, '_, DB> Executor<'p> for &'_ Pool<DB> where
    DB: Database,
    &'c mut <DB as Database>::Connection: for<'c> Executor<'c>,
    <&'c mut <DB as Database>::Connection as Executor<'c>>::Database == DB, 

type Database = DB

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<DB as Database>::QueryResult, <DB as Database>::Row>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    E: 'q + Execute<'q, <&'_ Pool<DB> as Executor<'p>>::Database>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<<DB as Database>::Row>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    E: 'q + Execute<'q, <&'_ Pool<DB> as Executor<'p>>::Database>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<<&'_ Pool<DB> as Executor<'p>>::Database as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<<&'_ Pool<DB> as Executor<'p>>::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.