Struct Blueprint 

pub struct Blueprint { /* private fields */ }

The columns and commands (indexes, keys, renames, drops) of a table, in the order they were added.

Implementations

impl Blueprint

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

An auto-incrementing 64-bit primary key named id. In schema::table SQLite cannot add it, as SQLite cannot add a primary key column to an existing table.

pub fn string(&mut self, name: &str) -> &mut Column

A VARCHAR(255); TEXT on SQLite. Change the length with .length(n).

pub fn text(&mut self, name: &str) -> &mut Column

A TEXT column.

pub fn medium_text(&mut self, name: &str) -> &mut Column

A MEDIUMTEXT column (up to 16 MB) on MySQL and MariaDB, as Laravel’s mediumText. It is TEXT on PostgreSQL, which has no size limit, and on SQLite, where text is limited only by the database’s size limits.

pub fn long_text(&mut self, name: &str) -> &mut Column

A LONGTEXT column (up to 4 GB) on MySQL and MariaDB, as Laravel’s longText. It is TEXT on PostgreSQL, which has no size limit, and on SQLite, where text is limited only by the database’s size limits. WordPress uses LONGTEXT for post content and for option and meta values.

pub fn integer(&mut self, name: &str) -> &mut Column

An INTEGER column.

pub fn big_integer(&mut self, name: &str) -> &mut Column

A BIGINT column; INTEGER on SQLite, whose integers are 64-bit already.

pub fn boolean(&mut self, name: &str) -> &mut Column

A boolean: BOOLEAN on PostgreSQL, TINYINT(1) elsewhere.

pub fn date_time(&mut self, name: &str) -> &mut Column

A date and time without a time zone: DATETIME, or TIMESTAMP(0) on PostgreSQL. Set fractional seconds with .precision(p) and a default of the current time with .use_current().

pub fn timestamp(&mut self, name: &str) -> &mut Column

A timestamp, as Laravel’s timestamp: TIMESTAMP on MySQL, TIMESTAMP(0) WITHOUT TIME ZONE on PostgreSQL, DATETIME on SQLite. Set fractional seconds with .precision(p) and a default of the current time with .use_current().

On MySQL and MariaDB with explicit_defaults_for_timestamp off (the MariaDB default before 10.10), the first TIMESTAMP column of a table that is NOT NULL and has no default gets DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP from the server. Laravel’s columns get the same. Add .nullable() or a default to avoid it.

pub fn binary(&mut self, name: &str) -> &mut Column

A column of raw bytes, as Laravel’s binary: BLOB, or BYTEA on PostgreSQL.

pub fn timestamps(&mut self)

Nullable created_at and updated_at columns.

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

where I: IntoIterator<Item = S>, S: AsRef<str>,

A unique constraint over columns, named {table}_{columns}_unique unless .name() gives another name.

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

where I: IntoIterator<Item = S>, S: AsRef<str>,

A plain index over columns, named {table}_{columns}_index unless .name() gives another name.

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

where I: IntoIterator<Item = S>, S: AsRef<str>,

A primary key over columns, as Laravel’s $table->primary(['a', 'b']): the table constraint PRIMARY KEY (a, b). For a key of one column, .primary() on the column does the same. In schema::table SQLite cannot add it: it is Error::Unsupported there.

pub fn foreign(&mut self, column: &str) -> &mut ForeignKey

A foreign key on column, named {table}_{column}_foreign unless .name() gives another name. In schema::table SQLite renders nothing, as SQLite cannot add a constraint to an existing table.

pub fn rename_column(&mut self, from: &str, to: &str)

Renames the column from to to: ALTER TABLE ... RENAME COLUMN. Only in schema::table.

RENAME COLUMN needs MySQL 8.0.3 or later, or MariaDB 10.5.2 or later. On older servers Laravel falls back to CHANGE old new <definition>; Orbit does not, and the server reports a syntax error.

pub fn drop_column(&mut self, name: &str)

Drops the column name: ALTER TABLE ... DROP COLUMN. Only in schema::table. SQLite needs version 3.35 or later.

pub fn drop_index(&mut self, name: &str)

Drops the index name, as Laravel’s dropIndex('name'). Only in schema::table.

On MySQL it drops a unique index too. On SQLite it drops a unique only when unique added it in schema::table: a unique declared in schema::create is an inline constraint there and cannot be dropped this way. On PostgreSQL unique always adds a constraint, and DROP INDEX cannot drop the index of a constraint. Orbit has no drop_unique (Laravel’s dropUnique).

pub fn drop_foreign(&mut self, name: &str)

Drops the foreign key name, as Laravel’s dropForeign('name'). Only in schema::table. SQLite renders nothing, as it cannot drop a constraint from an existing table and foreign added none there.

Trait Implementations

impl Clone for Blueprint

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 Blueprint

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

Formats the value using the given formatter.

impl Default for Blueprint

fn default() -> Self

Returns the “default value” for a type.