Struct Runner

pub struct Runner<C: MigrationContext> { /* private fields */ }

Run operations on a set of migrations for the chosen context.

Implementations

impl<C> Runner<C>

where C: MigrationContext,

pub fn new(context: C) -> Self

pub async fn apply_all(&mut self) -> TernResult<Report>

Apply all unapplied migrations.

pub async fn dryrun(&mut self) -> TernResult<Report>

Return the migration set that would be applied by apply_all.

pub async fn list_applied(&mut self) -> TernResult<Report>

List the migrations that have already been applied.

pub async fn init_history(&mut self) -> TernResult<()>

CREATE IF NOT EXISTS the history table.

pub async fn drop_history(&mut self) -> TernResult<()>

DROP the history table.

pub async fn soft_apply( &mut self, from_version: Option<i64>, to_version: Option<i64>, ) -> TernResult<Report>

Run a “soft apply” for the supplied range of migration versions.

This means that the migration will be saved in the history table, but will not have its query applied. This is useful in the case where you want to change migration tables, apply a patch to the current one, migrate from a different migration tool, etc.

If from_version (resp. to_version) is None, this will soft apply starting at the first migration (resp. ending with the last migration).