Struct sqlx_core::pool::PoolOptions [−][src]
pub struct PoolOptions<DB: Database> { /* fields omitted */ }
Implementations
Set the maximum number of connections that this pool should maintain.
Set the amount of time to attempt connecting to the database.
If this timeout elapses, Pool::acquire
will return an error.
Set the minimum number of connections to maintain at all times.
When the pool is built, this many connections will be automatically spun up.
If any connection is reaped by max_lifetime
or idle_timeout
and it brings
the connection count below this amount, a new connection will be opened to replace it.
Set the maximum lifetime of individual connections.
Any connection with a lifetime greater than this will be closed.
When set to None
, all connections live until either reaped by idle_timeout
or explicitly disconnected.
Infinite connections are not recommended due to the unfortunate reality of memory/resource leaks on the database-side. It is better to retire connections periodically (even if only once daily) to allow the database the opportunity to clean up data structures (parse trees, query metadata caches, thread-local storage, etc.) that are associated with a session.
Set a maximum idle duration for individual connections.
Any connection with an idle duration longer than this will be closed.
For usage-based database server billing, this can be a cost saver.
If true, the health of a connection will be verified by a call to Connection::ping
before returning the connection.
Defaults to true
.
pub fn after_connect<F>(self, callback: F) -> Self where
for<'c> F: Fn(&'c mut DB::Connection) -> BoxFuture<'c, Result<(), Error>> + 'static + Send + Sync,
pub fn after_connect<F>(self, callback: F) -> Self where
for<'c> F: Fn(&'c mut DB::Connection) -> BoxFuture<'c, Result<(), Error>> + 'static + Send + Sync,
Perform an action after connecting to the database.
Example
use sqlx_core::executor::Executor;
use sqlx_core::postgres::PgPoolOptions;
// PostgreSQL
let pool = PgPoolOptions::new()
.after_connect(|conn| Box::pin(async move {
conn.execute("SET application_name = 'your_app';").await?;
conn.execute("SET search_path = 'my_schema';").await?;
Ok(())
}))
.connect("postgres:// …").await?;
pub fn before_acquire<F>(self, callback: F) -> Self where
for<'c> F: Fn(&'c mut DB::Connection) -> BoxFuture<'c, Result<bool, Error>> + 'static + Send + Sync,
pub fn after_release<F>(self, callback: F) -> Self where
F: Fn(&mut DB::Connection) -> bool + 'static + Send + Sync,
Creates a new pool from this configuration and immediately establishes one connection.
pub async fn connect_with(
self,
options: <DB::Connection as Connection>::Options
) -> Result<Pool<DB>, Error>
pub async fn connect_with(
self,
options: <DB::Connection as Connection>::Options
) -> Result<Pool<DB>, Error>
Creates a new pool from this configuration and immediately establishes one connection.
Creates a new pool from this configuration and will establish a connections as the pool starts to be used.
Creates a new pool from this configuration and will establish a connections as the pool starts to be used.