Struct Blueprint 

pub struct Blueprint { /* private fields */ }

A table being created.

Implementations

impl Blueprint

pub fn new(table: impl Into<String>) -> Blueprint

A blueprint for table.

pub fn create( table: impl Into<String>, build: impl FnOnce(&mut Blueprint), ) -> Blueprint

Describe table with build, and hand back the blueprint.

pub fn table(&self) -> &str

The table’s name.

pub fn strict(&mut self) -> &mut Blueprint

Emit a plain CREATE TABLE, so creating one that exists is an error rather than a no-op.

The default is IF NOT EXISTS, which makes a migration safe to re-run by hand against a database somebody has already touched.

pub fn column( &mut self, name: impl Into<String>, kind: ColumnKind, ) -> &mut Column

A column of any kind. The typed helpers below all come through here.

pub fn id(&mut self) -> &mut Column

An auto-incrementing primary key named id.

pub fn big_increments(&mut self, name: impl Into<String>) -> &mut Column

An auto-incrementing 64-bit primary key.

pub fn increments(&mut self, name: impl Into<String>) -> &mut Column

An auto-incrementing 32-bit primary key.

pub fn string(&mut self, name: impl Into<String>) -> &mut Column

VARCHAR(255).

pub fn string_len(&mut self, name: impl Into<String>, len: u32) -> &mut Column

VARCHAR(len).

pub fn text(&mut self, name: impl Into<String>) -> &mut Column

Unbounded text.

Not indexable on MySQL without a prefix length, so reach for string for anything you will search or sort by.

pub fn integer(&mut self, name: impl Into<String>) -> &mut Column

A 32-bit signed integer.

pub fn big_integer(&mut self, name: impl Into<String>) -> &mut Column

A 64-bit signed integer.

pub fn unsigned_integer(&mut self, name: impl Into<String>) -> &mut Column

A 32-bit unsigned integer.

pub fn unsigned_big_integer(&mut self, name: impl Into<String>) -> &mut Column

A 64-bit unsigned integer.

pub fn foreign_id(&mut self, name: impl Into<String>) -> &mut Column

A foreign key column: unsigned 64-bit and indexed, ready for constrained_on.

table.foreign_id("author_id").constrained_on("users").cascade_on_delete();

pub fn boolean(&mut self, name: impl Into<String>) -> &mut Column

A boolean. An integer on SQLite and MySQL, which have no boolean type.

pub fn double(&mut self, name: impl Into<String>) -> &mut Column

A double-precision float. Not for money — see decimal.

pub fn decimal( &mut self, name: impl Into<String>, precision: u32, scale: u32, ) -> &mut Column

A fixed-point number, for money and anything else that must not round.

Read ColumnKind::Decimal before using it on SQLite, which has no fixed-point type and will store a float.

pub fn timestamp(&mut self, name: impl Into<String>) -> &mut Column

A timestamp.

pub fn date(&mut self, name: impl Into<String>) -> &mut Column

A calendar date, with no time.

pub fn binary(&mut self, name: impl Into<String>) -> &mut Column

Raw bytes.

pub fn json(&mut self, name: impl Into<String>) -> &mut Column

A JSON document.

pub fn timestamps(&mut self) -> &mut Blueprint

created_at and updated_at, both nullable.

Nullable because nothing here writes them for you — a row inserted by a migration or by hand would otherwise fail. A model that always sets them can declare its own NOT NULL columns instead.

pub fn soft_deletes(&mut self) -> &mut Column

A nullable deleted_at, for soft deletes.

pub fn primary<I, S>(&mut self, columns: I) -> &mut Blueprint

where I: IntoIterator<Item = S>, S: Into<String>,

A composite primary key.

What a pivot table wants: the pair is the key, so the same link cannot be inserted twice.

pub fn index<I, S>(&mut self, columns: I) -> &mut IndexDef

where I: IntoIterator<Item = S>, S: Into<String>,

A secondary index, named by convention.

pub fn unique<I, S>(&mut self, columns: I) -> &mut IndexDef

where I: IntoIterator<Item = S>, S: Into<String>,

A UNIQUE index over one or more columns.

pub fn to_statement(&self) -> TableCreateStatement

The CREATE TABLE statement, before rendering.

pub fn to_sql(&self, dialect: Dialect) -> Vec<String>

Every statement that creates this table on dialect, in order: the table, then its indexes.

pub fn to_reverse_sql(&self, dialect: Dialect) -> Vec<String>

The statements that undo it: drop the table.

The indexes go with it — no engine keeps an index on a table that is no longer there — so one statement is the whole reversal.

Trait Implementations

impl Clone for Blueprint

fn clone(&self) -> Blueprint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Blueprint

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

Formats the value using the given formatter.