Struct Column 

pub struct Column {
    pub name: String,
    pub data_type: ColumnType,
    pub nullable: bool,
    pub primary_key: bool,
    pub unique: bool,
    pub default: Option<String>,
    pub foreign_key: Option<ForeignKey>,
    pub check: Option<CheckConstraint>,
    pub generated: Option<Generated>,
}

A column definition with compile-time type safety.

Fields

name: String

Column name.

data_type: ColumnType

Compile-time validated data type.

nullable: bool

Whether the column accepts NULL.

primary_key: bool

Whether this column is a primary key.

unique: bool

Whether this column has a UNIQUE constraint.

default: Option<String>

Default value expression.

foreign_key: Option<ForeignKey>

Foreign key reference.

check: Option<CheckConstraint>

CHECK constraint (Phase 1)

generated: Option<Generated>

GENERATED column (Phase 3)

Implementations

impl Column

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

Create a new column with compile-time type validation.

pub fn not_null(self) -> Self

Mark as NOT NULL.

pub fn primary_key(self) -> Self

Set as primary key with compile-time validation. Validates that the column type can be a primary key.

This method is fail-soft: invalid type combinations are allowed to continue without panicking so production callers cannot crash on dynamic schema input. Use Column::try_primary_key for strict mode.

pub fn try_primary_key(self) -> Result<Self, String>

Strict variant of Column::primary_key.

Returns an error instead of panicking when type policy disallows PK.

pub fn unique(self) -> Self

Set as unique with compile-time validation. Validates that the column type supports indexing.

This method is fail-soft: invalid type combinations are allowed to continue without panicking so production callers cannot crash on dynamic schema input. Use Column::try_unique for strict mode.

pub fn try_unique(self) -> Result<Self, String>

Strict variant of Column::unique.

Returns an error instead of panicking when type policy disallows UNIQUE.

pub fn default(self, val: impl Into<String>) -> Self

Set a DEFAULT value expression.

pub fn references(self, table: &str, column: &str) -> Self

Add a foreign key reference to another table.

Example

Column::new("user_id", ColumnType::Uuid)
    .references("users", "id")
    .on_delete(FkAction::Cascade)

pub fn on_delete(self, action: FkAction) -> Self

Set the ON DELETE action for the foreign key.

pub fn on_update(self, action: FkAction) -> Self

Set the ON UPDATE action for the foreign key.

pub fn check(self, expr: CheckExpr) -> Self

Add a CHECK constraint (AST-native)

pub fn check_named(self, name: impl Into<String>, expr: CheckExpr) -> Self

Add a named CHECK constraint

pub fn deferrable(self) -> Self

Make foreign key DEFERRABLE

pub fn initially_deferred(self) -> Self

Make foreign key DEFERRABLE INITIALLY DEFERRED

pub fn initially_immediate(self) -> Self

Make foreign key DEFERRABLE INITIALLY IMMEDIATE

pub fn generated_stored(self, expr: impl Into<String>) -> Self

GENERATED ALWAYS AS (expr) STORED

pub fn generated_identity(self) -> Self

GENERATED ALWAYS AS IDENTITY

pub fn generated_by_default(self) -> Self

GENERATED BY DEFAULT AS IDENTITY

Trait Implementations

impl Clone for Column

fn clone(&self) -> Column

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Column

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

Formats the value using the given formatter.