Struct quaint::pooled::Builder

pub struct Builder { /* private fields */ }

A Builder to construct an instance of a Quaint pool.

Implementations

impl Builder

pub fn connection_limit(&mut self, connection_limit: usize)

The maximum number of connections in the pool.

• Defaults to two times the number of physical cores plus one.

pub fn max_idle(&mut self, max_idle: u64)

The maximum number of idle connections the pool can contain at the same time. If a connection goes idle (a query returns) and there are already this number of idle connections in the pool, a connection will be closed immediately. Consider using max_idle_lifetime to close idle connections less aggressively.

• Defaults to the same value as connection_limit.

pub fn pool_timeout(&mut self, pool_timeout: Duration)

A timeout for acquiring a connection with the check_out method. If not set, the method never times out.

Panics

Panics if pool_timeout is zero.

pub fn max_lifetime(&mut self, max_lifetime: Duration)

A time how long a connection can be kept in the pool before replaced with a new one. The reconnect happens in the next check_out.

• Defaults to not set, meaning connections are kept forever.

Panics

Panics if max_lifetime is zero.

pub fn max_idle_lifetime(&mut self, max_idle_lifetime: Duration)

A time how long an idling connection can be kept in the pool before replaced with a new one. The reconnect happens in the next check_out.

• Defaults to 300 seconds

Panics

Panics if max_idle_lifetime is zero.

pub fn test_on_check_out(&mut self, test_on_check_out: bool)

Perform a health check before returning a connection from the check_out. If the health check fails, a few reconnects are tried before returning the error and dropping the broken connection from the pool.

• Defaults to false, meaning connections are never tested on check_out.

pub fn health_check_interval(&mut self, health_check_interval: Duration)

Sets the interval how often a connection health will be tested when checking out from the pool. Must be used together with test_on_check_out set to true, otherwise does nothing.

• Defaults to not set, meaning a test is performed on every check_out.

Panics

Panics if health_check_interval is zero.

pub fn set_postgres_flavour(&mut self, flavour: PostgresFlavour)

Sets whether the URL points to a Postgres, Cockroach or Unknown database. This is used to avoid a network roundtrip at connection to set the search path.

The different behaviours are:

• Postgres: Always avoid a network roundtrip by setting the search path through client connection parameters.

• Cockroach: Avoid a network roundtrip if the schema name is deemed “safe” (i.e. no escape quoting required). Otherwise, set the search path through a database query.

• Unknown: Always add a network roundtrip by setting the search path through a database query.

• Defaults to PostgresFlavour::Unknown.

pub fn build(self) -> Quaint

Consume the builder and create a new instance of a pool.