Enum TenancyMode 

#[non_exhaustive]
pub enum TenancyMode {
    None,
    Row,
    Schema,
}

Tenancy isolation mode for multi-tenant deployments.

Determines how tenant data is separated at the database level. Configured via [fraiseql.tenancy] in fraiseql.toml.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

Single-tenant deployment, no isolation machinery.

Row

Row-level isolation: shared tables with @tenant_id column injection.

The compiler validates that all queries/mutations referencing @tenant_id-annotated types have inject_params wired correctly. At runtime, InjectedParamSource::Jwt resolves the tenant claim and injects a WHERE clause.

Schema

Schema-level isolation: per-tenant PostgreSQL schemas.

Each tenant’s connection pool is established with search_path = tenant_{key},public (lowered into the PostgreSQL startup options parameter), so every connection the pool opens carries it — including ones opened later to grow the pool and replacements created after a backend disconnects. TenantExecutorFactory provisions the schema via DDL at registration and verifies the isolation took before returning an executor.

It is deliberately not a SET search_path statement: that is session-scoped, so it configures one pooled connection and leaves the rest resolving against public (#809).

Trait Implementations

impl Clone for TenancyMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TenancyMode

impl Debug for TenancyMode

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

Formats the value using the given formatter.

impl Default for TenancyMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TenancyMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TenancyMode

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

Formats the value using the given formatter.

impl Eq for TenancyMode

impl PartialEq for TenancyMode

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TenancyMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TenancyMode