Struct TenantScope 

pub struct TenantScope { /* private fields */ }

Helper for building tenant-scoped SQL WHERE clauses.

Mirrors gokit’s ScopeToTenant by associating a field name with a tenant value. Adapter crates decide how to bind the returned value.

Examples

use rskit_database::TenantScope;
use std::num::NonZeroUsize;

let scope = TenantScope::new("workspace_id", "ws-123").unwrap();
assert_eq!(
    scope.where_clause(NonZeroUsize::new(1).unwrap()),
    "workspace_id = $1",
);
assert_eq!(scope.value(), "ws-123");

Implementations

impl TenantScope

pub fn new( column: impl Into<String>, value: impl Into<String>, ) -> AppResult<Self>

Create a new TenantScope for the given column and value.

Errors

Returns an error when the column is not a safe SQL identifier path or the tenant value is empty.

pub fn where_clause(&self, param_index: NonZeroUsize) -> String

Return a WHERE clause fragment like "workspace_id = $1".

param_index is the positional parameter number for the bind placeholder (1-based for PostgreSQL $N syntax).

pub fn value(&self) -> &str

Return the tenant value to bind.

pub fn column(&self) -> &str

Return the column name.

pub fn apply(&self, query: &str, param_index: NonZeroUsize) -> String

Append a tenant-scoped WHERE clause to the given SQL query.

Returns the modified query with WHERE column = $N appended, where N is param_index.

pub fn apply_and(&self, query: &str, param_index: NonZeroUsize) -> String

Append a tenant-scoped AND clause to the given SQL query.

Use this when the query already has a WHERE clause.

Trait Implementations

impl Clone for TenantScope

fn clone(&self) -> TenantScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TenantScope

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

Formats the value using the given formatter.