Struct ColumnDef 

pub struct ColumnDef {
    pub name: Ident,
    pub ty: ColumnType,
    pub not_null: bool,
    pub primary_key: bool,
    pub auto_increment: bool,
    pub unique: bool,
    pub default: Option<Expr>,
    pub check: Option<Expr>,
}

A column definition.

Fields

name: Ident

The column name.

ty: ColumnType

The logical type.

not_null: bool

Whether NOT NULL is set.

primary_key: bool

Whether the column is a single-column PRIMARY KEY.

auto_increment: bool

Whether AUTOINCREMENT is set; requires an INTEGER PRIMARY KEY.

unique: bool

Whether UNIQUE is set.

default: Option<Expr>

The DEFAULT expr, inlined as a literal when rendered.

check: Option<Expr>

The CHECK (expr) constraint.

Implementations

impl ColumnDef

pub fn new(name: impl IntoIden, ty: ColumnType) -> ColumnDef

A nullable column of the given type.

pub fn integer(name: impl IntoIden) -> ColumnDef

An INTEGER column.

pub fn boolean(name: impl IntoIden) -> ColumnDef

An INTEGER column holding a boolean.

pub fn real(name: impl IntoIden) -> ColumnDef

A REAL column.

pub fn text(name: impl IntoIden) -> ColumnDef

A TEXT column.

pub fn string(name: impl IntoIden, len: Option<u32>) -> ColumnDef

A TEXT column with an advisory length.

pub fn blob(name: impl IntoIden) -> ColumnDef

A BLOB column.

pub fn date(name: impl IntoIden) -> ColumnDef

A date column, stored as text.

pub fn date_time(name: impl IntoIden) -> ColumnDef

A naive timestamp column, stored as text.

pub fn timestamp_with_time_zone(name: impl IntoIden) -> ColumnDef

A zoned timestamp column, stored as RFC 3339 text.

pub fn uuid(name: impl IntoIden) -> ColumnDef

A UUID column, stored as text.

pub fn json(name: impl IntoIden) -> ColumnDef

A JSON column, stored as text.

pub fn decimal(name: impl IntoIden) -> ColumnDef

A decimal column, stored as text.

pub fn not_null(self) -> ColumnDef

Sets NOT NULL.

pub fn null(self) -> ColumnDef

Makes the column nullable, which is the default.

pub fn primary_key(self) -> ColumnDef

Sets PRIMARY KEY.

pub fn auto_increment(self) -> ColumnDef

Sets AUTOINCREMENT.

pub fn unique_key(self) -> ColumnDef

Sets UNIQUE.

pub fn default(self, value: impl Into<Expr>) -> ColumnDef

Sets DEFAULT expr.

pub fn check(self, expr: Expr) -> ColumnDef

Sets CHECK (expr).

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<(), Error>

Formats the value using the given formatter.

impl PartialEq for ColumnDef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColumnDef