Struct TenantContext 

pub struct TenantContext { /* private fields */ }

Tenant context for row-level security and data isolation.

Represents a single tenant in a multi-tenant system. All queries executed with this context will be filtered to only include data belonging to this tenant.

Implementations

impl TenantContext

pub fn new(id: impl Into<String>) -> Self

Create a new tenant context.

Arguments

• id - Unique tenant identifier

Example

let tenant = TenantContext::new("company-123");
assert_eq!(tenant.id(), "company-123");

pub fn id(&self) -> &str

Get the tenant ID.

pub fn created_at_iso8601(&self) -> Option<&str>

Get the creation timestamp in ISO 8601 format.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Set metadata key-value pair for the tenant.

pub fn get_metadata(&self, key: &str) -> Option<&str>

Get metadata value by key.

pub const fn metadata(&self) -> &HashMap<String, String>

Get all metadata.

pub fn from_jwt_claims(claims: &JsonValue) -> Result<Self, String>

Create a TenantContext from JWT claims.

Extracts the tenant_id from JWT claims and creates a new TenantContext.

Arguments

• claims - JWT claims as JSON object

Errors

Returns an error if:

• tenant_id claim is missing
• tenant_id is not a string

Example

use serde_json::json;
use fraiseql_core::tenancy::TenantContext;

let claims = json!({
    "sub": "user123",
    "tenant_id": "acme-corp",
    "email": "alice@acme.com"
});

let tenant = TenantContext::from_jwt_claims(&claims).unwrap();
assert_eq!(tenant.id(), "acme-corp");

Errors

Returns a String error if the tenant_id claim is missing or not a string.

pub fn where_clause(&self) -> String

Generate a WHERE clause for tenant filtering.

Returns a WHERE clause that restricts data to this tenant. Can be combined with existing WHERE clauses using AND.

Panics

Panics if the tenant ID contains characters outside the safe set ([A-Za-z0-9._-]). Tenant IDs are validated at context creation so this should never trigger in practice.

Security

Prefer where_clause_postgresql or where_clause_parameterized for production query execution. This method embeds the tenant ID directly into SQL and is only safe because the ID is strictly validated.

Example

let tenant = TenantContext::new("acme-corp");
let clause = tenant.where_clause();  // "tenant_id = 'acme-corp'"
assert_eq!(clause, "tenant_id = 'acme-corp'");

pub fn where_clause_postgresql(&self, param_index: usize) -> String

Generate a parameterized WHERE clause for PostgreSQL.

For use with parameterized queries to prevent SQL injection.

Arguments

• param_index - Parameter placeholder index (1-based for PostgreSQL)

Example

let tenant = TenantContext::new("acme-corp");
let clause = tenant.where_clause_postgresql(1);  // "tenant_id = $1"
assert_eq!(clause, "tenant_id = $1");

pub fn where_clause_parameterized(&self) -> String

Generate a parameterized WHERE clause for MySQL/SQLite.

For use with parameterized queries to prevent SQL injection.

Example

let tenant = TenantContext::new("acme-corp");
let clause = tenant.where_clause_parameterized();  // "tenant_id = ?"
assert_eq!(clause, "tenant_id = ?");

Trait Implementations

impl Clone for TenantContext

fn clone(&self) -> TenantContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TenantContext

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

Formats the value using the given formatter.