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 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 run_apply( &mut self, target_version: Option<i64>, dryrun: bool, ) -> TernResult<Report>

Apply unapplied migrations up to and including the specified version.

If dryrun is true, the report that is returned will show the unapplied version of each migration, including the query that was built, from the first unapplied up through target_version. Applying all unapplied is equivalent to passing None for target_version.

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

👎Deprecated since 3.1.0: use run_apply_all with dryrun = false

Apply all unapplied migrations.

pub async fn run_apply_all(&mut self, dryrun: bool) -> TernResult<Report>

Apply all unapplied migrations.

If dryrun is true, the report that is returned will show the unapplied version of each migration, including the query that was built, from the first unapplied up through the latest version in the migration source directory.

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

List the migrations that have already been applied.

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

👎Deprecated since 3.1.0: no valid use case for start_version

pub async fn run_soft_apply( &mut self, target_version: Option<i64>, dryrun: bool, ) -> TernResult<Report>

Run a “soft apply” of the migrations up to and including the specified version.

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 dryrun is true, the report that is returned will show the unapplied migrations that would be written to the history table as if they had been applied, including the query that was built but not ran, from the first unapplied up through target_version.