Struct Column 

pub struct Column {

    pub schema: Cow<'static, str>,
    pub table: Cow<'static, str>,
    pub name: Cow<'static, str>,
    pub sql_type: Cow<'static, str>,
    pub type_schema: Option<Cow<'static, str>>,
    pub not_null: bool,
    pub default: Option<Cow<'static, str>>,
    pub generated: Option<Generated>,
    pub identity: Option<Identity>,
    pub dimensions: Option<i32>,
    pub comment: Option<Cow<'static, str>>,
    pub collate: Option<Cow<'static, str>>,
    pub ordinal_position: Option<i32>,
}

A table column, as stored in migration snapshots.

Fields

schema: Cow<'static, str>

Schema name

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)

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

Schema of a custom or enum type

not_null: bool

NOT NULL

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

DEFAULT value as SQL

generated: Option<Generated>

Generated column configuration

identity: Option<Identity>

Identity column configuration

dimensions: Option<i32>

Number of array dimensions

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

Column comment, emitted as COMMENT ON COLUMN

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

Collation name (e.g. "en_US", "C"). None means the database default collation and no COLLATE clause is emitted.

ordinal_position: Option<i32>

Ordinal position within the table (1-based).

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

Implementations

impl Column

pub fn new( schema: impl Into<Cow<'static, str>>, 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 default.

pub const fn not_null(self) -> Self

Adds NOT NULL.

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

Sets the DEFAULT value, written as SQL.

pub fn identity(self, identity: Identity) -> Self

Makes the column an identity column.

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

Sets the column comment.

pub fn schema(&self) -> &str

Returns the schema name.

pub fn table(&self) -> &str

Returns the table name.

pub fn name(&self) -> &str

Returns the column name.

pub fn sql_type(&self) -> &str

Returns the SQL type.

impl Column

pub fn type_sql(&self) -> String

Renders the column’s type.

Built-in types render verbatim (integer, varchar(255)). When type_schema names a non-public schema, the custom/enum type name is quoted and schema-qualified ("app"."status"). For public the schema is elided and the name is only quoted when it needs it (mixed case or other non-lowercase characters), so ordinary lowercase enum names keep rendering exactly as before. Parenthesized type parameters stay outside the quotes; array dimensions are appended.

pub fn to_column_sql(&self) -> String

Renders the column definition as used inside CREATE TABLE, such as "name" text NOT NULL.

DEFAULT is left out on identity and generated columns, which PostgreSQL does not allow to have one.

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