Struct Conventions 

#[non_exhaustive]
pub struct Conventions {
    pub tenant_column: Option<String>,
    pub tenant_setting: Option<String>,
    pub user_setting: Option<String>,
    pub soft_delete_column: Option<String>,
    pub managed_columns: Vec<String>,
    pub version_column: Option<String>,
}

Opt-in conventions: columns that mean the same thing in every table that has them (ADR 0010). Each convention applies only to the tables that have the named column, and all are off by default.

let mut conventions = rok_sqlc::Conventions::rok();
conventions.soft_delete_column = Some("removed_at".into());
let mut config = rok_sqlc::Config::default();
config.conventions = conventions;

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tenant_column: Option<String>

The tenant column, which scopes every generated operation on a table to one tenant given by the caller.

tenant_setting: Option<String>

The PostgreSQL setting the generated session helper sets to the current tenant, for row-level security policies.

user_setting: Option<String>

The PostgreSQL setting the generated session helper sets to the acting user, for audit triggers.

soft_delete_column: Option<String>

The soft-delete column: a nullable timestamp recording when a row was deleted.

managed_columns: Vec<String>

Managed columns, maintained by the database (defaults and triggers): left out of create inputs and update patches, kept in rows.

version_column: Option<String>

The version column, for optimistic concurrency on update.

Implementations

impl Conventions

pub const PRESETS: &[&str]

The preset names Conventions::preset knows.

pub fn rok() -> Self

The Rok ERP’s conventions: tenant column organization_id (with the settings app.organization_id and app.user_id), soft-delete column deleted_at, managed columns updated_at and row_version, and version column row_version.

pub fn preset(name: &str) -> Option<Self>

The preset with this name (one of Conventions::PRESETS), or None for an unknown name.

Trait Implementations

impl Clone for Conventions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Conventions

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

Formats the value using the given formatter.

impl Default for Conventions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Conventions

impl PartialEq for Conventions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Conventions