Enum TableConstraint 

#[non_exhaustive]
pub enum TableConstraint {
    PrimaryKey {
        auto_increment: bool,
        columns: Vec<ColumnName>,
        strategy: PrimaryKeyAdditionStrategy,
    },
    Unique {
        name: Option<String>,
        columns: Vec<ColumnName>,
        strategy: UniqueConstraintStrategy,
    },
    ForeignKey {
        name: Option<String>,
        columns: Vec<ColumnName>,
        ref_table: TableName,
        ref_columns: Vec<ColumnName>,
        on_delete: Option<ReferenceAction>,
        on_update: Option<ReferenceAction>,
        orphan_strategy: ForeignKeyOrphanStrategy,
    },
    Check {
        name: String,
        expr: String,
        strategy: CheckViolationStrategy,
    },
    Index {
        name: Option<String>,
        columns: Vec<ColumnName>,
    },
}

A table-level constraint produced by TableDef::normalize.

Inline column constraints (primary_key, unique, index, foreign_key) declared in model JSON files are converted into TableConstraint variants during normalization. You rarely construct these directly; the planner and SQL generator consume them.

This enum is #[non_exhaustive]: new variants may be added in future releases. Downstream match expressions should include a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PrimaryKey

Primary key constraint, optionally with auto-increment (serial / identity) semantics.

strategy controls how pre-existing duplicate rows in the chosen column set are handled when this constraint is added to an already-populated table. The canonical default is [PrimaryKeyAdditionStrategy::DeleteDuplicates { keep: KeepPolicy::First }] (omitted from the JSON wire format). NULL violations on PK columns are handled separately by the F1 fill_with mechanism; the revision CLI prompts for fill values on every nullable PK column.

strategy is stripped from model.schema.json but preserved in migration.schema.json.

Fields

auto_increment: bool

columns: Vec<ColumnName>

strategy: PrimaryKeyAdditionStrategy

Unique

Unique constraint ensuring no two rows share the same value(s) in the listed columns.

strategy controls how pre-existing duplicate rows are handled when this constraint is added to an already-populated table. The canonical default is [UniqueConstraintStrategy::DeleteDuplicates { keep: KeepPolicy::First }], which matches v0.1.x behaviour and is omitted from the JSON wire format. Other strategies (e.g. DeleteDuplicates) emit a pre-cleanup step ahead of ADD CONSTRAINT so the migration succeeds even when production data has duplicates.

strategy is stripped from model.schema.json by the schema generator (vespertide-schema-gen), but preserved in migration.schema.json since migration files carry the revision CLI’s stamped choice.

Fields

name: Option<String>

columns: Vec<ColumnName>

strategy: UniqueConstraintStrategy

ForeignKey

Foreign key constraint linking columns in this table to columns in another table.

orphan_strategy controls how pre-existing orphan rows are handled when this constraint is added to an already-populated table. The canonical default is ForeignKeyOrphanStrategy::NullifyOrphans (omitted from the JSON wire format). The revision CLI re-prompts the user for an explicit choice; the default exists only so v0.1.x model files continue to deserialize.

orphan_strategy is stripped from model.schema.json by the schema generator but preserved in migration.schema.json.

Fields

name: Option<String>

columns: Vec<ColumnName>

ref_table: TableName

ref_columns: Vec<ColumnName>

on_delete: Option<ReferenceAction>

on_update: Option<ReferenceAction>

orphan_strategy: ForeignKeyOrphanStrategy

Check

Arbitrary SQL CHECK expression enforced by the database on every write.

strategy controls how pre-existing violating rows are handled when this constraint is added to an already-populated table. The canonical default is CheckViolationStrategy::NullifyViolatingColumn (omitted from the JSON wire format). The revision CLI re-prompts the user for an explicit choice; the default exists only so v0.1.x model files continue to deserialize.

Cleanup SQL is emitted only when the expression matches a narrow recognisable shape (<col> <op> <literal> or <col> IN (...)); more complex expressions skip pre-cleanup and rely on the database to validate at apply time.

strategy is stripped from model.schema.json but preserved in migration.schema.json.

Fields

name: String

expr: String

strategy: CheckViolationStrategy

Index

Non-unique index to speed up queries on the listed columns.

Fields

name: Option<String>

columns: Vec<ColumnName>

Implementations

impl TableConstraint

pub fn kind(&self) -> ConstraintKind

Returns the high-level kind of this constraint.

pub fn columns(&self) -> &[ColumnName]

Returns the columns referenced by this constraint. For Check constraints, returns an empty slice (expression-based, not column-based).

pub fn with_prefix(self, prefix: &str) -> Self

Apply a prefix to referenced table names in this constraint. Only affects ForeignKey constraints (which reference other tables).

Trait Implementations

impl Clone for TableConstraint

fn clone(&self) -> TableConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableConstraint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableConstraint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TableConstraint

impl JsonSchema for TableConstraint

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for TableConstraint

fn cmp(&self, other: &TableConstraint) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TableConstraint

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

fn partial_cmp(&self, other: &TableConstraint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TableConstraint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TableConstraint