Struct ensemble::migrations::Migrator

pub struct Migrator { /* private fields */ }

The migration runner.

Implementations

impl Migrator

pub async fn new() -> Result<Self, Error>

Creates a new Migrator.

Errors

Returns an error if a connection to the database cannot be established, or if the migrations cannot be retrieved.

pub fn register(&mut self, name: String, migration: Box<dyn Migration>)

Registers a migration.

Panics

Panics if a migration with the same name has already been registered.

pub fn status(&self) -> Vec<StoredMigration>

Returns a list of migrations that have been run.

pub fn pending(&self) -> HashMap<&str, &dyn Migration>

Returns a list of migrations that have not been run.

pub async fn run(self) -> Result<(), Error>

Runs the migrations.

Errors

Returns an error if the migrations fail, or if a connection to the database cannot be established.

pub async fn rollback(self, batches: u64) -> Result<(), Error>

Rolls back the last n batches of migrations.

Errors

Returns an error if the migrations fail, or if a connection to the database cannot be established.