Struct LogicalModel 

pub struct LogicalModel {
    pub name: String,
    pub tables: IndexMap<TableId, Table>,
    /* private fields */
}

The full logical (relational) model.

Fields

name: String

Database / schema name.

tables: IndexMap<TableId, Table>

Tables, keyed for O(1) lookup; iteration order is insertion order.

Implementations

impl LogicalModel

pub fn new(name: impl Into<String>) -> Self

Construct a new empty logical model.

pub fn add_table(&mut self, name: impl Into<String>) -> TableId

Create a new empty table.

pub fn table(&self, id: TableId) -> Result<&Table>

Borrow a table by handle.

pub fn table_mut(&mut self, id: TableId) -> Result<&mut Table>

Mutably borrow a table by handle.

pub fn add_column( &mut self, table: TableId, name: impl Into<String>, data_type: DataType, ) -> Result<ColumnId>

Append a new column to table.

pub fn set_primary_key( &mut self, table: TableId, columns: Vec<ColumnId>, ) -> Result<ConstraintId>

Add (or replace) a primary-key constraint on table.

pub fn add_foreign_key( &mut self, table: TableId, fk: ForeignKey, ) -> Result<ConstraintId>

Add a foreign-key constraint on table.

pub fn add_unique( &mut self, table: TableId, columns: Vec<ColumnId>, ) -> Result<ConstraintId>

Add a UNIQUE constraint over the given columns.

impl LogicalModel

pub fn to_sql(&self, dialect: SqlDialect) -> String

Render this logical model as a SQL DDL script for the given dialect.

Tables are emitted in author order, with primary keys inline and foreign keys deferred to ALTER TABLE statements at the bottom of the script (so that forward references between tables resolve cleanly).

Trait Implementations

impl Clone for LogicalModel

fn clone(&self) -> LogicalModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogicalModel

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

Formats the value using the given formatter.

impl Default for LogicalModel

fn default() -> LogicalModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LogicalModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LogicalModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.