Struct migrate_core::PlanBuilder

pub struct PlanBuilder { /* fields omitted */ }

Bbuilder for Plan to allow its convenient configuration

Implementations

impl PlanBuilder

pub fn ctx_provider(&mut self, provider: impl MigrationCtxProvider) -> &mut Self

Register the MigrationCtxProvider that will be used to provide context for the migrations in the built Plan

pub fn migration(
    &mut self,
    name: impl Into<String>,
    migration: impl Migration + 'static
) -> &mut Self

Append the Migration to the list of migrations configured for the plan. Keep in mind that it is important to keep the migrations in order and add new migrations strictly to the end of the list so that new migrations obvserve the changes from previous migrations.

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

Use forced stack lock. Beware that setting it to true is dangerous and may lead to migration state corruptions! See more detailed info at migrate_state::StateLock::lock().

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

Create the builder for rendering the current migration configuration in this PlanBuilder.

pub async fn build(
    self,
    kind: &MigrationsSelection<'_>
) -> Result<Plan, PlanBuildError>

Finish building the migration plan.

This method reads the migration state and figures out which migrations to run up() or down. This information is stored in the returned Plan struct.

There are various reasons for this method to fail, see PlanBuildError for more details on possible error outcomes.