Struct SchemaPerTenantConfig 

pub struct SchemaPerTenantConfig {
    pub schema_prefix: String,
    pub shared_schema: String,
    pub auto_create_schema: bool,
    pub system_uses_public: bool,
    pub max_schema_length: usize,
    pub schema_pattern: String,
    pub drop_on_delete: bool,
    pub template_schema: Option<String>,
}

Configuration for schema-per-tenant tenancy.

Example

use helios_persistence::strategy::SchemaPerTenantConfig;

let config = SchemaPerTenantConfig {
    schema_prefix: "tenant_".to_string(),
    shared_schema: "shared".to_string(),
    auto_create_schema: true,
    ..Default::default()
};

Fields

schema_prefix: String

Prefix for tenant schema names.

The full schema name is {prefix}{tenant_id}.

shared_schema: String

Name of the shared schema for system resources.

auto_create_schema: bool

Whether to automatically create schemas for new tenants.

system_uses_public: bool

Whether to use the public schema for the system tenant.

max_schema_length: usize

Maximum schema name length (PostgreSQL limit is 63).

schema_pattern: String

Characters allowed in schema names (derived from tenant IDs).

drop_on_delete: bool

Whether to drop schema on tenant deletion.

template_schema: Option<String>

Template schema to copy when creating new tenants.

If set, new tenant schemas are created by copying this template.

Implementations

impl SchemaPerTenantConfig

pub fn new() -> Self

Creates a new configuration with defaults.

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

Sets the schema prefix.

pub fn with_shared_schema(self, schema: impl Into<String>) -> Self

Sets the shared schema name.

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

Sets the template schema.

pub fn with_drop_on_delete(self) -> Self

Enables dropping schemas on tenant deletion.

Trait Implementations

impl Clone for SchemaPerTenantConfig

fn clone(&self) -> SchemaPerTenantConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaPerTenantConfig

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

Formats the value using the given formatter.

impl Default for SchemaPerTenantConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchemaPerTenantConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SchemaPerTenantConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.