Struct TableDef

#[non_exhaustive]
pub struct TableDef {
    pub name: Identifier,
    pub product_type_ref: AlgebraicTypeRef,
    pub primary_key: Option<ColId>,
    pub columns: Vec<ColumnDef>,
    pub indexes: StrMap<IndexDef>,
    pub constraints: StrMap<ConstraintDef>,
    pub sequences: StrMap<SequenceDef>,
    pub schedule: Option<ScheduleDef>,
    pub table_type: TableType,
    pub table_access: TableAccess,
}

A data structure representing the validated definition of a database table.

Cannot be created directly. Construct a ModuleDef by validating a RawModuleDef instead, and then access the tables from there.

This struct holds information about the table, including its name, columns, indexes, constraints, sequences, type, and access rights.

Validation rules:

• The table name must be a valid identifier.
• The table’s columns must be sorted according to [crate::db::ordering::canonical_ordering].
• The table’s indexes, constraints, and sequences must be sorted by their keys.
• The table’s column types may refer only to types in the containing DatabaseDef’s typespace.
• The table’s column names must be unique.

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.

name: Identifier

The name of the table. Unique within a module, acts as the table’s identifier. Must be a valid [crate::db::identifier::Identifier].

product_type_ref: AlgebraicTypeRef

A reference to a ProductType containing the columns of this table. This is the single source of truth for the table’s columns. All elements of the ProductType must have names.

Like all types in the module, this must have the default element ordering, UNLESS a custom ordering is declared via ModuleDef.misc_exports for this type.

primary_key: Option<ColId>

The primary key of the table, if present. Must refer to a valid column.

Currently, there must be a unique constraint and an index corresponding to the primary key. Eventually, we may remove the requirement for an index.

The database engine does not actually care about this, but client code generation does.

columns: Vec<ColumnDef>

The columns of this table. This stores the information in product_type_ref in a more convenient-to-access format.

indexes: StrMap<IndexDef>

The indices on the table, indexed by name.

constraints: StrMap<ConstraintDef>

The unique constraints on the table, indexed by name.

sequences: StrMap<SequenceDef>

The sequences for the table, indexed by name.

schedule: Option<ScheduleDef>

The schedule for the table, if present.

table_type: TableType

Whether this is a system- or user-created table.

table_access: TableAccess

Whether this table is public or private.

Implementations

impl TableDef

pub fn get_column(&self, id: ColId) -> Option<&ColumnDef>

Get a column of the TableDef.

pub fn get_column_by_name(&self, name: &Identifier) -> Option<&ColumnDef>

Get a column by the column’s name.

Trait Implementations

impl Clone for TableDef

fn clone(&self) -> TableDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableDef

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

Formats the value using the given formatter.

impl From<TableDef> for RawTableDefV9

fn from(val: TableDef) -> Self

Converts to this type from the input type.

impl ModuleDefLookup for TableDef

type Key<'a> = &'a Identifier

A reference to a definition of this type within a module def. This reference should be portable across migrations.

fn key(&self) -> Self::Key<'_>

Get a reference to this definition.

fn lookup<'a>(module_def: &'a ModuleDef, key: Self::Key<'_>) -> Option<&'a Self>

Look up this entity in the module def.

impl PartialEq for TableDef

fn eq(&self, other: &TableDef) -> 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 Eq for TableDef

impl StructuralPartialEq for TableDef