Struct DatabasePoolCacheConfig 

pub struct DatabasePoolCacheConfig {
    pub host: String,
    pub port: u16,
    pub root_secret_name: Option<String>,
    pub root_iam: bool,
    pub max_connections: Option<u32>,
    pub max_connections_root: Option<u32>,
    pub acquire_timeout: Option<u64>,
    pub idle_timeout: Option<u64>,
    pub cache_duration: Option<u64>,
    pub cache_capacity: Option<u64>,
    pub credentials_cache_duration: Option<u64>,
    pub credentials_cache_capacity: Option<u64>,
}

Config for the database pool

Fields

host: String

Database host

port: u16

Database port

root_secret_name: Option<String>

Name of the secrets manager secret to use when connecting to the root “docbox” database if using secret based authentication

root_iam: bool

Whether to use IAM authentication to connect to the root database instead of secrets

max_connections: Option<u32>

Max number of active connections per tenant database pool

This is the maximum number of connections that should be allocated for performing all queries against each specific tenant.

Ensure a reasonable amount of connections are allocated but make sure that the max_connections * your number of tenants stays within the limits for your database

Default: 10

max_connections_root: Option<u32>

Max number of active connections per “docbox” database pool

This is the maximum number of connections that should be allocated for performing queries like:

• Listing tenants
• Getting tenant details

These pools are often short lived and complete their queries very fast and thus don’t need a huge amount of resources allocated to them

Default: 2

acquire_timeout: Option<u64>

Timeout before a acquiring a database connection is considered a failure

Default: 60s

idle_timeout: Option<u64>

If a connection has been idle for this duration the connection will be closed and released back to the database for other consumers

Default: 10min

cache_duration: Option<u64>

Duration in seconds idle database pools are allowed to be cached before they are closed

Default: 48h

cache_capacity: Option<u64>

Maximum database pools to maintain in the cache at once. If the cache capacity is exceeded old pools will be closed and removed from the cache

This capacity should be aligned with your expected number of tenants along with your max_connections to ensure your database has enough connections to accommodate all tenants.

Default: 50

credentials_cache_duration: Option<u64>

Duration in seconds database credentials (host, port, password, ..etc) are allowed to be cached before they are refresh from the secrets manager

Default: 12h

credentials_cache_capacity: Option<u64>

Maximum database credentials to maintain in the cache at once. If the cache capacity is exceeded old credentials will be removed from the cache

Default: 50

Implementations

impl DatabasePoolCacheConfig

pub fn from_env() -> Result<DatabasePoolCacheConfig, DatabasePoolCacheConfigError>

Trait Implementations

impl Clone for DatabasePoolCacheConfig

fn clone(&self) -> DatabasePoolCacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabasePoolCacheConfig

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

Formats the value using the given formatter.

impl Default for DatabasePoolCacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DatabasePoolCacheConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DatabasePoolCacheConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.