Struct Config

pub struct Config {

    pub url: Option<String>,
    pub user: Option<String>,
    pub password: Option<String>,
    pub dbname: Option<String>,
    pub options: Option<String>,
    pub application_name: Option<String>,
    pub ssl_mode: Option<SslMode>,
    pub host: Option<String>,
    pub hosts: Option<Vec<String>>,
    pub hostaddr: Option<IpAddr>,
    pub hostaddrs: Option<Vec<IpAddr>>,
    pub port: Option<u16>,
    pub ports: Option<Vec<u16>>,
    pub connect_timeout: Option<Duration>,
    pub keepalives: Option<bool>,
    pub keepalives_idle: Option<Duration>,
    pub target_session_attrs: Option<TargetSessionAttrs>,
    pub channel_binding: Option<ChannelBinding>,
    pub load_balance_hosts: Option<LoadBalanceHosts>,
    pub manager: Option<ManagerConfig>,
    pub pool: Option<PoolConfig>,
}

Configuration object.

Example (from environment)

By enabling the serde feature you can read the configuration using the config crate as following:

PG__HOST=pg.example.com
PG__USER=john_doe
PG__PASSWORD=topsecret
PG__DBNAME=example
PG__POOL__MAX_SIZE=16
PG__POOL__TIMEOUTS__WAIT__SECS=5
PG__POOL__TIMEOUTS__WAIT__NANOS=0

#[derive(serde::Deserialize, serde::Serialize)]
struct Config {
    pg: deadpool_postgres::Config,
}
impl Config {
    pub fn from_env() -> Result<Self, config::ConfigError> {
        let mut cfg = config::Config::builder()
           .add_source(config::Environment::default().separator("__"))
           .build()?;
           cfg.try_deserialize()
    }
}

Fields

url: Option<String>

Initialize the configuration by parsing the URL first. Note: All the other options override settings defined by the URL except for the host and hosts options which are additive!

user: Option<String>

See tokio_postgres::Config::user.

password: Option<String>

See tokio_postgres::Config::password.

dbname: Option<String>

See tokio_postgres::Config::dbname.

options: Option<String>

See tokio_postgres::Config::options.

application_name: Option<String>

See tokio_postgres::Config::application_name.

ssl_mode: Option<SslMode>

See tokio_postgres::Config::ssl_mode.

host: Option<String>

This is similar to Config::hosts but only allows one host to be specified.

Unlike tokio_postgres::Config this structure differentiates between one host and more than one host. This makes it possible to store this configuration in an environment variable.

See tokio_postgres::Config::host.

hosts: Option<Vec<String>>

See tokio_postgres::Config::host.

hostaddr: Option<IpAddr>

See tokio_postgres::Config::hostaddr.

hostaddrs: Option<Vec<IpAddr>>

See tokio_postgres::Config::hostaddr.

port: Option<u16>

This is similar to Config::ports but only allows one port to be specified.

Unlike tokio_postgres::Config this structure differentiates between one port and more than one port. This makes it possible to store this configuration in an environment variable.

See tokio_postgres::Config::port.

ports: Option<Vec<u16>>

See tokio_postgres::Config::port.

connect_timeout: Option<Duration>

See tokio_postgres::Config::connect_timeout.

keepalives: Option<bool>

See tokio_postgres::Config::keepalives.

keepalives_idle: Option<Duration>

See tokio_postgres::Config::keepalives_idle.

target_session_attrs: Option<TargetSessionAttrs>

See tokio_postgres::Config::target_session_attrs.

channel_binding: Option<ChannelBinding>

See tokio_postgres::Config::channel_binding.

load_balance_hosts: Option<LoadBalanceHosts>

See tokio_postgres::Config::load_balance_hosts.

manager: Option<ManagerConfig>

Manager configuration.

pool: Option<PoolConfig>

Pool configuration.

Implementations

impl Config

pub fn new() -> Config

Create a new Config instance with default values. This function is identical to Config::default().

pub fn create_pool<T>( &self, runtime: Option<Runtime>, tls: T, ) -> Result<Pool<Manager>, CreatePoolError<ConfigError>>

where T: MakeTlsConnect<Socket> + Clone + Sync + Send + 'static, <T as MakeTlsConnect<Socket>>::Stream: Sync + Send, <T as MakeTlsConnect<Socket>>::TlsConnect: Sync + Send, <<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,

Creates a new Pool using this Config.

Errors

See CreatePoolError for details.

pub fn builder<T>(&self, tls: T) -> Result<PoolBuilder<Manager>, ConfigError>

where T: MakeTlsConnect<Socket> + Clone + Sync + Send + 'static, <T as MakeTlsConnect<Socket>>::Stream: Sync + Send, <T as MakeTlsConnect<Socket>>::TlsConnect: Sync + Send, <<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,

Creates a new PoolBuilder using this Config.

Errors

See ConfigError and tokio_postgres::Error for details.

pub fn get_pg_config(&self) -> Result<Config, ConfigError>

Returns tokio_postgres::Config which can be used to connect to the database.

pub fn get_manager_config(&self) -> ManagerConfig

Returns ManagerConfig which can be used to construct a deadpool::managed::Pool instance.

pub fn get_pool_config(&self) -> PoolConfig

Returns deadpool::managed::PoolConfig which can be used to construct a deadpool::managed::Pool instance.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.