Struct Migration 

pub struct Migration {
    pub name: String,
    pub up: String,
    pub down: String,
    /* private fields */
}

One migration: its name, and what applies it (up) and reverts it (down). Either fixed SQL (Migration::new, files) or schema statements (Migration::schema).

Fields

name: String

The folder name, such as 20261108000000_create_users.

up: String

The contents of up.sql. Empty for a schema migration, which carries statements instead.

down: String

The contents of down.sql. Empty for a schema migration.

Implementations

impl Migration

pub fn new( name: impl Into<String>, up: impl Into<String>, down: impl Into<String>, ) -> Self

A migration from its name and SQL, for code that builds migrations itself.

pub fn schema( name: impl Into<String>, up: Vec<Statement>, down: Vec<Statement>, ) -> Self

A migration written with the schema builder. The statements are rendered for the connected database when the migrator runs or rolls it back, so one migration serves every database. A statement that cannot be rendered fails the migration with that error, before any of its SQL runs. The migration keeps the same transaction and batch behaviour as an SQL one.

A schema::statement runs its SQL as written. A statement limited with Statement::only to another database family renders nothing, so it does not run there.

Trait Implementations

impl Clone for Migration

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 Migration

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

Formats the value using the given formatter.