Struct PolicyDef 

pub struct PolicyDef {
    pub schema: &'static str,
    pub table: &'static str,
    pub name: &'static str,
    pub as_clause: Option<&'static str>,
    pub for_clause: Option<&'static str>,
    pub to: Option<&'static [&'static str]>,
    pub using: Option<&'static str>,
    pub with_check: Option<&'static str>,
}

A row-level security policy that can be built in a const.

Clause values are SQL as written: as_clause is PERMISSIVE or RESTRICTIVE, for_clause is ALL, SELECT, INSERT, UPDATE or DELETE, and using / with_check are boolean expressions.

Examples

use drizzle_types::postgres::ddl::PolicyDef;

const OWNER_ONLY: PolicyDef = PolicyDef::new("public", "posts", "owner_only")
    .for_clause("select")
    .to(&["authenticated"])
    .using("author_id = current_user_id()");

assert_eq!(
    OWNER_ONLY.into_policy().create_policy_sql(),
    "CREATE POLICY \"owner_only\" ON \"posts\" AS PERMISSIVE FOR SELECT \
     TO \"authenticated\" USING (author_id = current_user_id());"
);

Fields

schema: &'static str

Schema name

table: &'static str

Table name

name: &'static str

Policy name

as_clause: Option<&'static str>

AS clause: PERMISSIVE (the default when None) or RESTRICTIVE

for_clause: Option<&'static str>

FOR clause: ALL, SELECT, INSERT, UPDATE or DELETE

to: Option<&'static [&'static str]>

TO role names; public means PUBLIC

using: Option<&'static str>

USING expression

with_check: Option<&'static str>

WITH CHECK expression

Implementations

impl PolicyDef

pub const fn new( schema: &'static str, table: &'static str, name: &'static str, ) -> Self

Creates a policy with no clauses set.

pub const fn as_clause(self, clause: &'static str) -> Self

Sets the AS clause.

pub const fn for_clause(self, clause: &'static str) -> Self

Sets the FOR clause.

pub const fn to(self, roles: &'static [&'static str]) -> Self

Sets the TO role names.

pub const fn using(self, expr: &'static str) -> Self

Sets the USING expression.

pub const fn with_check(self, expr: &'static str) -> Self

Sets the WITH CHECK expression.

pub fn into_policy(self) -> Policy

Converts to the runtime Policy.

Trait Implementations

impl Clone for PolicyDef

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 PolicyDef

impl Debug for PolicyDef

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

Formats the value using the given formatter.

impl Eq for PolicyDef

impl From<PolicyDef> for Policy

fn from(def: PolicyDef) -> Self

Converts to this type from the input type.

impl Hash for PolicyDef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PolicyDef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PolicyDef