Struct DatabasePerTenantConfig 

pub struct DatabasePerTenantConfig {

    pub connection_template: String,
    pub pool_per_tenant: bool,
    pub max_pools: Option<usize>,
    pub min_connections_per_pool: u32,
    pub max_connections_per_pool: u32,
    pub idle_timeout_secs: u64,
    pub max_tenant_id_length: usize,
    pub tenant_id_pattern: String,
    pub auto_create_database: bool,
    pub database_prefix: String,
    pub database_suffix: String,
    pub default_host: String,
    pub default_port: u16,
    pub system_database: String,
}

Configuration for database-per-tenant strategy.

Example

use helios_persistence::strategy::DatabasePerTenantConfig;

let config = DatabasePerTenantConfig {
    connection_template: "postgres://user:pass@{host}/{tenant}_db".to_string(),
    pool_per_tenant: true,
    max_pools: Some(100),
    ..Default::default()
};

Fields

connection_template: String

Connection string template with placeholders.

Supported placeholders:

• {tenant} - The tenant ID (sanitized)
• {tenant_hash} - Hash of tenant ID (for long IDs)
• {host} - Database host (from host_resolver or default)
• {port} - Database port
• {user} - Database user
• {password} - Database password

pool_per_tenant: bool

Whether to maintain a separate connection pool per tenant.

When true, each tenant gets its own pool for better isolation. When false, connections are created on-demand (less resource usage).

max_pools: Option<usize>

Maximum number of tenant pools to maintain.

If exceeded, least recently used pools are closed. Only applies when pool_per_tenant is true.

min_connections_per_pool: u32

Minimum connections per tenant pool.

max_connections_per_pool: u32

Maximum connections per tenant pool.

idle_timeout_secs: u64

Connection idle timeout.

max_tenant_id_length: usize

Maximum length for tenant IDs in database names.

tenant_id_pattern: String

Allowed characters in tenant IDs (regex pattern).

auto_create_database: bool

Whether to auto-create databases for new tenants.

database_prefix: String

Database name prefix.

database_suffix: String

Database name suffix.

default_host: String

Default host for database connections.

default_port: u16

Default port for database connections.

system_database: String

System database name for administrative operations.

Implementations

impl DatabasePerTenantConfig

pub fn new() -> Self

Creates a new configuration with defaults.

pub fn with_connection_template(self, template: impl Into<String>) -> Self

Sets the connection template.

pub fn with_auto_create(self) -> Self

Enables auto-creation of databases.

pub fn with_max_pools(self, max: usize) -> Self

Sets the maximum number of pools.

pub fn with_database_prefix(self, prefix: impl Into<String>) -> Self

Sets the database prefix.

pub fn without_pool_per_tenant(self) -> Self

Disables per-tenant pools (use on-demand connections).

Trait Implementations

impl Clone for DatabasePerTenantConfig

fn clone(&self) -> DatabasePerTenantConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabasePerTenantConfig

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

Formats the value using the given formatter.

impl Default for DatabasePerTenantConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DatabasePerTenantConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DatabasePerTenantConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.