Struct SchemaConfig 

pub struct SchemaConfig {
    pub schema_prefix: Option<String>,
    pub schema_suffix: Option<String>,
    pub shared_schema: Option<String>,
    pub auto_create: bool,
    pub default_schema: Option<String>,
    pub search_path_format: SearchPathFormat,
}

Configuration for schema-based tenant isolation.

Fields

schema_prefix: Option<String>

Prefix for tenant schema names (e.g., “tenant_” -> “tenant_acme”).

schema_suffix: Option<String>

Suffix for tenant schema names.

shared_schema: Option<String>

Name of the shared schema for common tables.

auto_create: bool

Whether to create schemas automatically.

default_schema: Option<String>

Default schema for new tenants.

search_path_format: SearchPathFormat

Schema search path format.

Implementations

impl SchemaConfig

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

Set the schema prefix.

pub fn with_suffix(self, suffix: impl Into<String>) -> Self

Set the schema suffix.

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

Set the shared schema name.

pub fn with_auto_create(self) -> Self

Enable auto-creation of schemas.

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

Set the default schema.

pub fn with_search_path(self, format: SearchPathFormat) -> Self

Set the search path format.

pub fn schema_name(&self, tenant_id: &str) -> String

Generate the schema name for a tenant.

This is a pure string composition; no validation is performed. Use Self::try_schema_name to reject tenant ids that would compose into an invalid SQL identifier.

pub fn try_schema_name(&self, tenant_id: &str) -> QueryResult<String>

Generate the schema name for a tenant, validating the composed name.

The composed schema name must match the strict SQL identifier charset ^[A-Za-z_][A-Za-z0-9_]*$; otherwise a QueryError is returned so a malicious tenant id is rejected before it can reach a SQL statement.

pub fn search_path(&self, tenant_id: &str) -> String

Generate the search_path SQL for a tenant.

The composed tenant schema name is validated against the strict SQL identifier charset ^[A-Za-z_][A-Za-z0-9_]*$ at the point of SQL generation. A name outside that charset is emitted as a double-quoted identifier (with embedded " doubled) so a malicious tenant id cannot break out of the identifier and inject SQL. Use Self::try_search_path to reject invalid tenant ids with an error instead.

pub fn try_search_path(&self, tenant_id: &str) -> QueryResult<String>

Generate the search_path SQL for a tenant, validating all schema names first.

Returns a QueryError if the composed tenant schema name or the configured shared schema is not a valid SQL identifier (^[A-Za-z_][A-Za-z0-9_]*$).

Trait Implementations

impl Clone for SchemaConfig

fn clone(&self) -> SchemaConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaConfig

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

Formats the value using the given formatter.

impl Default for SchemaConfig

fn default() -> SchemaConfig

Returns the “default value” for a type.