Skip to main content

Schema

Struct Schema 

Source
pub struct Schema {
    pub tables: HashMap<String, Table>,
    pub indexes: Vec<Index>,
    pub migrations: Vec<MigrationHint>,
    pub extensions: Vec<Extension>,
    pub comments: Vec<Comment>,
    pub sequences: Vec<Sequence>,
    pub enums: Vec<EnumType>,
    pub views: Vec<ViewDef>,
    pub functions: Vec<SchemaFunctionDef>,
    pub triggers: Vec<SchemaTriggerDef>,
    pub grants: Vec<Grant>,
    pub policies: Vec<RlsPolicy>,
}
Expand description

A complete database schema.

Fields§

§tables: HashMap<String, Table>§indexes: Vec<Index>§migrations: Vec<MigrationHint>§extensions: Vec<Extension>

PostgreSQL extensions (e.g. uuid-ossp, pgcrypto, PostGIS)

§comments: Vec<Comment>

Schema-level comments on tables/columns

§sequences: Vec<Sequence>

Standalone sequences

§enums: Vec<EnumType>

Standalone ENUM types

§views: Vec<ViewDef>

Views

§functions: Vec<SchemaFunctionDef>

PL/pgSQL functions

§triggers: Vec<SchemaTriggerDef>

Triggers

§grants: Vec<Grant>

GRANT/REVOKE permissions

§policies: Vec<RlsPolicy>

RLS policies

Implementations§

Source§

impl Schema

Source

pub fn new() -> Self

Source

pub fn add_table(&mut self, table: Table)

Source

pub fn add_index(&mut self, index: Index)

Source

pub fn add_hint(&mut self, hint: MigrationHint)

Source

pub fn add_extension(&mut self, ext: Extension)

Source

pub fn add_comment(&mut self, comment: Comment)

Source

pub fn add_sequence(&mut self, seq: Sequence)

Source

pub fn add_enum(&mut self, enum_type: EnumType)

Source

pub fn add_view(&mut self, view: ViewDef)

Source

pub fn add_function(&mut self, func: SchemaFunctionDef)

Source

pub fn add_trigger(&mut self, trigger: SchemaTriggerDef)

Source

pub fn add_grant(&mut self, grant: Grant)

Source

pub fn validate(&self) -> Result<(), Vec<String>>

Validate all foreign key references in the schema.

Trait Implementations§

Source§

impl Clone for Schema

Source§

fn clone(&self) -> Schema

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Schema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Schema

Source§

fn default() -> Schema

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Schema

§

impl RefUnwindSafe for Schema

§

impl Send for Schema

§

impl Sync for Schema

§

impl Unpin for Schema

§

impl UnwindSafe for Schema

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ColumnValue<Value> for T