Struct schemer::Migrator

pub struct Migrator<T: Adapter> { /* private fields */ }

Primary schemer type for defining and applying migrations.

Implementations

impl<T: Adapter> Migrator<T>

pub fn new(adapter: T) -> Migrator<T>

Create a Migrator using the given Adapter.

pub fn register(
    &mut self,
    migration: Box<T::MigrationType>
) -> Result<(), MigratorError<T::Error>>

Register a migration into the dependency graph.

pub fn register_multiple(
    &mut self,
    migrations: Vec<Box<T::MigrationType>>
) -> Result<(), MigratorError<T::Error>>

Register multiple migrations into the dependency graph. The Vec does not need to be order by dependency structure.

pub fn up(&mut self, to: Option<Uuid>) -> Result<(), MigratorError<T::Error>>

Apply migrations as necessary to so that the specified migration is applied (inclusive).

If to is None, apply all registered migrations.

pub fn down(&mut self, to: Option<Uuid>) -> Result<(), MigratorError<T::Error>>

Revert migrations as necessary so that no migrations dependent on the specified migration are applied. If the specified migration was already applied, it will still be applied.

If to is None, revert all applied migrations.