Struct ColumnDef 

pub struct ColumnDef { /* private fields */ }

Schema metadata for a single column: SQL type, nullability, defaults, constraints, and other DDL-level options.

Returned by ColumnTrait::def and used by SeaORM’s schema builder to generate CREATE TABLE / ALTER TABLE statements. Most fields are set declaratively via attributes on a #[derive(DeriveEntityModel)] Model; the chainable methods below cover the cases that need to be configured at runtime.

Implementations

impl ColumnDef

pub fn unique(self) -> Self

Marks the column as UNIQUE

pub fn seaography_ignore(self) -> Self

Set Seaography ignore

pub fn unique_key(self, key: &str) -> Self

This column belongs to a unique key

pub fn renamed_from(self, col: &str) -> Self

This column is renamed from a previous name

pub fn comment(self, v: &str) -> Self

Set column comment

pub fn null(self) -> Self

Mark the column as nullable

pub fn nullable(self) -> Self

Mark the column as nullable

pub fn indexed(self) -> Self

Set the indexed field to true

pub fn default_value<T>(self, value: T) -> Self

where T: Into<Value>,

Set the default value

pub fn default<T>(self, default: T) -> Self

where T: Into<SimpleExpr>,

Set the default value or expression of a column

pub fn extra(self, value: &str) -> Self

Set the extra SQL string for the column (e.g. “COLLATE NOCASE”)

pub fn get_column_type(&self) -> &ColumnType

Get ColumnType as reference

pub fn get_column_default(&self) -> Option<&SimpleExpr>

Get the column’s default value/expression, if one is set.

pub fn is_null(&self) -> bool

Returns true if the column is nullable

pub fn is_unique(&self) -> bool

Returns true if the column is unique

pub fn seaography(&self) -> &SeaographyColumnAttr

Get Seaography attribute

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

fn def(self) -> ColumnDef

Wrap this ColumnType in a fresh ColumnDef.

fn get_enum_name(&self) -> Option<&DynIden>

Name of the database ENUM type if this column is an enum, None otherwise.

impl Debug for ColumnDef

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

Formats the value using the given formatter.

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