Struct Migrator 

pub struct Migrator<'a> { /* private fields */ }

Applies and rolls back migrations, tracking which have run.

Implementations

impl<'a> Migrator<'a>

pub fn new(db: &'a Database, migrations: Vec<&'a dyn Migration>) -> Self

pub fn with_table(self, table: &str) -> Result<Self>

Record applied migrations in a different table.

pub fn table(&self) -> &str

pub async fn prepare(&self) -> Result<()>

Create the tracking table if it is not there yet.

The batch number is what makes migrate:rollback undo one deployment’s worth of migrations rather than one migration.

pub async fn applied(&self) -> Result<Vec<String>>

Names already applied, in the order they ran.

pub async fn pending(&self) -> Result<Vec<&'a dyn Migration>>

Migrations that have not run yet.

pub async fn run(&self) -> Result<MigrationReport>

Run every pending migration.

A migration is not wrapped in a transaction, which is also what Laravel does. Wrapping one here would be a lie: the migration’s DDL and the tracking insert are separate statements, a pooled connection is not guaranteed to be the same one twice, and MySQL commits implicitly before and after every DDL statement regardless — a CREATE TABLE cannot be rolled back there at all.

A migration that needs to be atomic should open a transaction itself with db.begin().

pub async fn rollback(&self) -> Result<MigrationReport>

Roll back the most recent batch.

pub async fn fresh(&self, environment: &str) -> Result<MigrationReport>

Drop every table in the schema, then migrate from scratch.

Refuses to run in production: this is the command that would delete a live database, and a confirmation prompt is not available to a library.

pub async fn status(&self) -> Result<Vec<(String, bool)>>

Which migrations have run and which have not.