Struct ColumnDef 

pub struct ColumnDef {
    pub(crate) col_type: ColumnType,
    pub(crate) null: bool,
    pub(crate) unique: bool,
    pub(crate) indexed: bool,
    pub(crate) default: Option<SimpleExpr>,
    pub(crate) comment: Option<String>,
}

Defines a Column for an Entity

Fields

col_type: ColumnType

null: bool

unique: bool

indexed: bool

default: Option<SimpleExpr>

comment: Option<String>

Implementations

impl ColumnDef

pub fn unique(self) -> ColumnDef

Marks the column as UNIQUE

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

Set column comment

pub fn null(self) -> ColumnDef

Mark the column as nullable

pub fn nullable(self) -> ColumnDef

Mark the column as nullable

pub fn indexed(self) -> ColumnDef

Set the indexed field to true

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

where T: Into<Value>,

Set the default value

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

where T: Into<SimpleExpr>,

Set the default value or expression of a column

pub fn get_column_type(&self) -> &ColumnType

Get ColumnType as reference

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

Get Option as reference

pub fn is_null(&self) -> bool

Returns true if the column is nullable

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

Instantiate a new ColumnDef

fn get_enum_name(&self) -> Option<&SeaRc<dyn Iden>>

Get the name of the enum if this is a enum column

impl Debug for ColumnDef

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

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