Struct Schema 

pub struct Schema {
    pub datasource: Option<Datasource>,
    pub models: IndexMap<SmolStr, Model>,
    pub enums: IndexMap<SmolStr, Enum>,
    pub types: IndexMap<SmolStr, CompositeType>,
    pub views: IndexMap<SmolStr, View>,
    pub server_groups: IndexMap<SmolStr, ServerGroup>,
    pub policies: Vec<Policy>,
    pub raw_sql: Vec<RawSql>,
    pub relations: Vec<Relation>,
}

A complete Prax schema.

Fields

datasource: Option<Datasource>

Datasource configuration (database connection and extensions).

models: IndexMap<SmolStr, Model>

All models in the schema.

enums: IndexMap<SmolStr, Enum>

All enums in the schema.

types: IndexMap<SmolStr, CompositeType>

All composite types in the schema.

views: IndexMap<SmolStr, View>

All views in the schema.

server_groups: IndexMap<SmolStr, ServerGroup>

Server groups for multi-server configurations.

policies: Vec<Policy>

PostgreSQL Row-Level Security policies.

raw_sql: Vec<RawSql>

Raw SQL definitions.

relations: Vec<Relation>

Resolved relations (populated after validation).

Implementations

impl Schema

pub fn new() -> Schema

Create a new empty schema.

pub fn set_datasource(&mut self, datasource: Datasource)

Set the datasource configuration.

pub fn datasource(&self) -> Option<&Datasource>

Get the datasource configuration.

pub fn has_vector_support(&self) -> bool

Check if the schema has vector extension enabled.

pub fn required_extensions(&self) -> Vec<&PostgresExtension>

Get all required PostgreSQL extensions from the datasource.

pub fn add_model(&mut self, model: Model)

Add a model to the schema.

pub fn add_enum(&mut self, e: Enum)

Add an enum to the schema.

pub fn add_type(&mut self, t: CompositeType)

Add a composite type to the schema.

pub fn add_view(&mut self, v: View)

Add a view to the schema.

pub fn add_server_group(&mut self, sg: ServerGroup)

Add a server group to the schema.

pub fn add_policy(&mut self, policy: Policy)

Add a PostgreSQL Row-Level Security policy.

pub fn add_raw_sql(&mut self, sql: RawSql)

Add a raw SQL definition.

pub fn get_model(&self, name: &str) -> Option<&Model>

Get a model by name.

pub fn get_model_mut(&mut self, name: &str) -> Option<&mut Model>

Get a mutable model by name.

pub fn get_enum(&self, name: &str) -> Option<&Enum>

Get an enum by name.

pub fn get_type(&self, name: &str) -> Option<&CompositeType>

Get a composite type by name.

pub fn get_view(&self, name: &str) -> Option<&View>

Get a view by name.

pub fn get_server_group(&self, name: &str) -> Option<&ServerGroup>

Get a server group by name.

pub fn server_group_names(&self) -> impl Iterator<Item = &str>

Get all server group names.

pub fn get_policy(&self, name: &str) -> Option<&Policy>

Get a policy by name.

pub fn policies_for(&self, model: &str) -> Vec<&Policy>

Get all policies for a specific model/table.

pub fn has_policies(&self, model: &str) -> bool

Check if a model has Row-Level Security policies.

pub fn policy_names(&self) -> impl Iterator<Item = &str>

Get all policy names.

pub fn type_exists(&self, name: &str) -> bool

Check if a type name exists (model, enum, type, or view).

pub fn model_names(&self) -> impl Iterator<Item = &str>

Get all model names.

pub fn enum_names(&self) -> impl Iterator<Item = &str>

Get all enum names.

pub fn relations_for(&self, model: &str) -> Vec<&Relation>

Get relations for a specific model.

pub fn relations_from(&self, model: &str) -> Vec<&Relation>

Get relations originating from a specific model.

pub fn merge(&mut self, other: Schema)

Merge another schema into this one.

impl Schema

pub fn stats(&self) -> SchemaStats

Get statistics about the schema.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>( __deserializer: __D, ) -> Result<Schema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Schema

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

Formats the value using the given formatter.

impl PartialEq for Schema

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Schema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Schema