Struct Column 

pub struct Column { /* private fields */ }

One column, described.

Returned by every Blueprint column method so modifiers chain:

table.string("email").unique();
table.text("bio").nullable();
table.integer("hits").default(0);

Implementations

impl Column

pub fn name(&self) -> &str

The column’s name.

pub fn nullable(&mut self) -> &mut Self

Allow NULL.

Columns are NOT NULL by default, which is the opposite of SQL’s default — nullability should be a decision somebody made, not one they got by omission.

pub fn default(&mut self, value: impl Into<Value>) -> &mut Self

A default value. Also backfills existing rows when a NOT NULL column is added to a table that already has some.

pub fn primary(&mut self) -> &mut Self

Make it the primary key.

pub fn auto_increment(&mut self) -> &mut Self

Let the database assign it. Implies primary.

pub fn unique(&mut self) -> &mut Self

A single-column UNIQUE constraint.

pub fn index(&mut self) -> &mut Self

A single-column index.

pub fn constrained_on(&mut self, table: impl Into<String>) -> &mut Self

Point this column at table’s primary key.

The referenced column defaults to id; say otherwise with references.

pub fn references( &mut self, table: impl Into<String>, column: impl Into<String>, ) -> &mut Self

Point this column at table.column.

pub fn cascade_on_delete(&mut self) -> &mut Self

Delete the referencing rows when the referenced row goes.

pub fn null_on_delete(&mut self) -> &mut Self

NULL the referencing column when the referenced row goes. The column has to be nullable.

pub fn on_delete(&mut self, action: Action) -> &mut Self

What happens to this row when the referenced one is deleted.

pub fn on_update(&mut self, action: Action) -> &mut Self

What happens to this row when the referenced key is updated.

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.