Struct migrant_lib::Migrator

pub struct Migrator { /* fields omitted */ }

Migration applicator

Implementations

impl Migrator

pub fn with_config(config: &Config) -> Self

Initialize a new Migrator with a given &Config

pub fn direction(&mut self, dir: Direction) -> &mut Self

Set direction. Default is Up. Up => run up.sql. Down => run down.sql.

pub fn force(&mut self, force: bool) -> &mut Self

Set force to forcefully apply migrations regardless of errors

pub fn fake(&mut self, fake: bool) -> &mut Self

Set fake to fake application of migrations. Applied migrations table will be updated as if migrations were actually run.

pub fn all(&mut self, all: bool) -> &mut Self

Set all to run all remaining available migrations in the given direction

pub fn show_output(&mut self, show_output: bool) -> &mut Self

Toggle migration application output. Default is true

pub fn swallow_completion(&mut self, swallow_completion: bool) -> &mut Self

Don’t return any ErrorKind::MigrationComplete errors when running Migrator::apply

All other errors will still be returned

pub fn apply(&self) -> Result<()>

Apply migrations using current configuration

Returns an ErrorKind::MigrationComplete if all migrations in the given direction have already been applied, unless swallow_completion is set to true.

Trait Implementations

impl Clone for Migrator

fn clone(&self) -> Migrator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Migrator

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

Formats the value using the given formatter.