Struct migrate_core::Plan

pub struct Plan { /* fields omitted */ }

Contains a fixed snapshot of the migration state and the list of migrations that will be either skipped as already completed (according to the migration state) or not selected (as per MigrationsSelection) and the list of migrations that will be run as a result of exucting this migration Plan.

Use Plan::builder() method to configure and create the Plan

Implementations

impl Plan

pub fn builder(state_lock: impl StateLock + 'static) -> PlanBuilder

Returns the builder for this Plan to allow its convenient configuration

pub fn display(&self) -> PlanDisplayBuilder<'_>

Returns a builder that will allow for configuring how the migration Plan will be rendered via std::fmt::Display impl.

pub async fn exec(self, run_mode: MigrationRunMode) -> Result<(), PlanExecError>

Execute the migration plan by running the migration scripts.