Struct Column 

pub struct Column {
    pub table: Cow<'static, str>,
    pub name: Cow<'static, str>,
    pub sql_type: Cow<'static, str>,
    pub not_null: bool,
    pub autoincrement: Option<bool>,
    pub primary_key: Option<bool>,
    pub unique: Option<bool>,
    pub default: Option<Cow<'static, str>>,
    pub generated: Option<Generated>,
    pub collate: Option<Cow<'static, str>>,
    pub ordinal_position: Option<i32>,
}

A table column, as stored in migration snapshots.

The boolean constraints are Option<bool> to match the snapshot format; None and Some(false) both mean unset.

Fields

table: Cow<'static, str>

Parent table name

name: Cow<'static, str>

Column name

sql_type: Cow<'static, str>

SQL type, such as "INTEGER" (serialized as type)

not_null: bool

Is this column NOT NULL?

autoincrement: Option<bool>

Is this column AUTOINCREMENT?

primary_key: Option<bool>

Is this column a PRIMARY KEY?

unique: Option<bool>

Is this column UNIQUE?

default: Option<Cow<'static, str>>

DEFAULT value as SQL

generated: Option<Generated>

Generated column configuration

collate: Option<Cow<'static, str>>

Collation sequence (BINARY, NOCASE, RTRIM, or custom). None means the default BINARY collation and no COLLATE clause is emitted.

ordinal_position: Option<i32>

Ordinal position within the table (cid, 0-based).

This is primarily populated by introspection and used for stable codegen ordering.

Implementations

impl Column

pub fn new( table: impl Into<Cow<'static, str>>, name: impl Into<Cow<'static, str>>, sql_type: impl Into<Cow<'static, str>>, ) -> Self

Creates a nullable column with no constraints.

pub const fn not_null(self) -> Self

Adds NOT NULL.

pub const fn autoincrement(self) -> Self

Marks the column AUTOINCREMENT. Unlike ColumnDef::autoincrement, this does not set primary_key or not_null.

pub fn default_value(self, value: impl Into<Cow<'static, str>>) -> Self

Sets the DEFAULT value, written as SQL.

pub fn name(&self) -> &str

Returns the column name.

pub fn table(&self) -> &str

Returns the table name.

pub fn sql_type(&self) -> &str

Returns the SQL type.

pub const fn is_primary_key(&self) -> bool

Returns true if primary_key is Some(true).

pub const fn is_autoincrement(&self) -> bool

Returns true if autoincrement is Some(true).

pub const fn is_unique(&self) -> bool

Returns true if unique is Some(true).

impl Column

pub fn to_column_sql(&self, inline_pk: bool, inline_unique: bool) -> String

Renders the column definition as used inside CREATE TABLE, such as `name` TEXT NOT NULL.

inline_pk adds PRIMARY KEY (and AUTOINCREMENT, which is otherwise dropped); inline_unique adds UNIQUE. NOT NULL is left out only on an inline INTEGER PRIMARY KEY, which aliases the rowid and is never NULL.

pub fn add_column_sql(&self) -> String

Renders ALTER TABLE ... ADD COLUMN ...;.

pub fn drop_column_sql(&self) -> String

Renders ALTER TABLE ... DROP COLUMN ...;.

Trait Implementations

impl Clone for Column

fn clone(&self) -> Self

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.

impl Default for Column

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Column

impl From<ColumnDef> for Column

fn from(def: ColumnDef) -> Self

Converts to this type from the input type.

impl PartialEq for Column

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Column