Struct ColumnDef 

pub struct ColumnDef {
    pub name: &'static str,
    pub data_type: DataTypeKind,
    pub auto_increment: bool,
    pub nullable: bool,
    pub primary_key: bool,
    pub unique: bool,
    pub foreign_key: Option<ForeignKeyDef>,
    pub default: Option<fn() -> Value>,
    pub renamed_from: &'static [&'static str],
}

Defines a column in a database table.

Fields

name: &'static str

The name of the column.

data_type: DataTypeKind

The data type of the column.

auto_increment: bool

Indicates if this column is auto-incrementing (applicable for integer types). Cannot be nullable.

nullable: bool

Indicates if this column can contain NULL values.

primary_key: bool

Indicates if this column is part of the primary key.

unique: bool

Indicates if this column has unique values across all records.

foreign_key: Option<ForeignKeyDef>

Foreign key definition, if any.

default: Option<fn() -> Value>

Default value constructor, if any.

Populated by the #[default = ...] attribute on a #[derive(Table)] field. Consumed by the migration planner when adding a non-nullable column to satisfy the DefaultMissing check.

renamed_from: &'static [&'static str]

Previous names this column was known by, in chronological order.

Populated by the #[renamed_from("old1", "old2", ...)] attribute. The migration planner walks this list to detect a RenameColumn op when a stored column with one of these names matches the compiled column.

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 From<ColumnDef> for JoinColumnDef

fn from(def: ColumnDef) -> Self

Converts to this type from the input type.

impl PartialEq for ColumnDef

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

impl Eq for ColumnDef