Struct Statement 

pub struct Statement { /* private fields */ }

A schema change, ready to render for any database.

Implementations

impl Statement

pub fn only(self, dialect: Dialect) -> Self

Limits the statement to one database family, as a Laravel migration wraps a call in if (DB::getDriverName() === 'mysql') { ... }. On that family the statement renders as usual; on the others it renders to an empty list, and nothing runs. It works on every statement: create, table, drop and statement.

A statement for another family is not rendered at all, so an invalid name in it is not reported there either. Calling only twice keeps the last call.

pub fn to_sql(&self, driver: Driver) -> Vec<String>

Renders the statement for driver: one SQL statement per element, to run in order.

Panics

Panics when a name is invalid or a default has no SQL literal. Use try_to_sql to get the error instead.

pub fn try_to_sql(&self, driver: Driver) -> Result<Vec<String>, Error>

Renders the statement for driver, or the error for an invalid name. A table, column or index column name must not be empty or contain a backtick or a double quote, the rule of the query builder. An operation the database cannot do, or an alter-only command such as rename_column inside create, is Error::Unsupported. A raw statement is never an error, and a statement limited by only to another family renders as an empty list.

Trait Implementations

impl Clone for Statement

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 Statement

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

Formats the value using the given formatter.