Struct refinery::Runner

pub struct Runner { /* fields omitted */ }

Struct that represents the entrypoint to run the migrations, an instance of this struct is returned by the embed_migrations and the mod_migrations runner function, Runner should not need to be instantiated manually

Methods

impl Runner

pub fn new(migrations: &[Migration]) -> Runner

pub fn set_grouped(self, grouped: bool) -> Runner

Set true if all migrations should be grouped and run in a single transaction by default this is set to false

pub fn set_abort_divergent(self, abort_divergent: bool) -> Runner

Set true if migration process should abort if divergent migrations are found i.e. applied migrations with the same version but different name or checksum from the ones on the filesystem by default this is set to true

pub fn set_abort_missing(self, abort_divergent: bool) -> Runner

Set true if migration process should abort if missing migrations are found i.e. applied migrations that are not found on the filesystem, or migrations found on filesystem with a version inferior to the last one applied but not applied

pub fn run<'a, C>(&self, conn: &'a mut C) -> Result<(), Error> where
    C: MigrateGrouped<'a> + Migrate, 

Runs the Migrations in the supplied database connection