Struct ColumnDef 

pub struct ColumnDef {
    pub name: ColumnName,
    pub type: ColumnType,
    pub nullable: bool,
    pub default: Option<StringOrBool>,
    pub comment: Option<String>,
    pub primary_key: Option<PrimaryKeySyntax>,
    pub unique: Option<StrOrBoolOrArray>,
    pub index: Option<StrOrBoolOrArray>,
    pub foreign_key: Option<ForeignKeySyntax>,
}

Definition of a single table column, including its type, nullability, and inline constraints.

Inline constraints (primary_key, unique, index, foreign_key) are the preferred way to declare constraints in model JSON files. Call TableDef::normalize to convert them into table-level TableConstraint entries before diffing or SQL generation.

Use ColumnDef::new to construct a column programmatically, then chain the setter methods (.primary_key(), .unique(), .index(), .foreign_key(), .default(), .comment()) to attach optional fields.

Fields

name: ColumnName

type: ColumnType

nullable: bool

default: Option<StringOrBool>

comment: Option<String>

primary_key: Option<PrimaryKeySyntax>

unique: Option<StrOrBoolOrArray>

index: Option<StrOrBoolOrArray>

foreign_key: Option<ForeignKeySyntax>

Implementations

impl ColumnDef

pub fn new( name: impl Into<ColumnName>, type: ColumnType, nullable: bool, ) -> Self

Construct a new column with required fields only. Use the .primary_key(), .unique(), .index(), .foreign_key(), .default(), .comment() setters to add optional fields.

Examples

use vespertide_core::{ColumnDef, ColumnType, SimpleColumnType};
let id = ColumnDef::new("id", ColumnType::Simple(SimpleColumnType::Integer), false);

pub fn primary_key(self, pk: PrimaryKeySyntax) -> Self

Mark this column as part of the primary key.

pub fn unique(self, unique: StrOrBoolOrArray) -> Self

Add a unique constraint to this column.

pub fn index(self, index: StrOrBoolOrArray) -> Self

Add an index on this column.

pub fn foreign_key(self, fk: ForeignKeySyntax) -> Self

Add a foreign key reference from this column.

pub fn default(self, default: StringOrBool) -> Self

Set the column default value.

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

Add a column comment.

Trait Implementations

impl Clone for ColumnDef

fn clone(&self) -> ColumnDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ColumnDef

impl JsonSchema for ColumnDef

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 PartialEq for ColumnDef

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

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 ColumnDef