Trait migrate_core::MigrationCtxProvider

pub trait MigrationCtxProvider: Send + 'static {
    type Ctx: Send + 'static;
    #[must_use]
    fn create_in_commit_mode<'async_trait>(
        self: Box<Self>
    ) -> Pin<Box<dyn Future<Output = Result<Self::Ctx, Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>
    where
        Self: 'async_trait;
    #[must_use]
    fn create_in_no_commit_mode<'async_trait>(
        self: Box<Self>
    ) -> Pin<Box<dyn Future<Output = Option<Result<Self::Ctx, Box<dyn Error + Send + Sync>>>> + Send + 'async_trait>>
    where
        Self: 'async_trait;
}

Gives methods for creating the context for the migration. This should most likely create a database client, or initialize some state, for example ensure an executable is installed.

Associated Types

type Ctx: Send + 'static

The type this provider creates. There must be only one provider of the given type, because Rust type id will be used as a key to lookup the context for migration.

Required methods

#[must_use]

fn create_in_commit_mode<'async_trait>(
    self: Box<Self>
) -> Pin<Box<dyn Future<Output = Result<Self::Ctx, Box<dyn Error + Send + Sync>>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Create context for real migration. All changes that will be made to the target migration object should be applied for real.

#[must_use]

fn create_in_no_commit_mode<'async_trait>(
    self: Box<Self>
) -> Pin<Box<dyn Future<Output = Option<Result<Self::Ctx, Box<dyn Error + Send + Sync>>>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Create the context for no-commit (or dry-run) migration. All changes that will be made to the target migration object should not be applied for real.

‘no-commit’ migration context will most likely just log what would be executed when the migration runs for real.

Implementors