Trait Migration

pub trait Migration
where
    Self: Send + Sync,
{
    type Ctx: MigrationContext;

    // Required methods
    fn migration_id(&self) -> MigrationId;
    fn content(&self) -> String;
    fn no_tx(&self) -> bool;
    fn build<'a>(
        &'a self,
        ctx: &'a mut Self::Ctx,
    ) -> BoxFuture<'a, TernResult<Query>>;

    // Provided methods
    fn version(&self) -> i64 { ... }
    fn to_applied(
        &self,
        duration_ms: i64,
        applied_at: DateTime<Utc>,
    ) -> AppliedMigration { ... }
}

A single migration in a migration set.

Required Associated Types

type Ctx: MigrationContext

A migration context that is sufficient to build this migration.

Required Methods

fn migration_id(&self) -> MigrationId

Get the MigrationId for this migration.

fn content(&self) -> String

The raw file content of the migration source file.

fn no_tx(&self) -> bool

Whether this migration should not be applied in a database transaction.

fn build<'a>( &'a self, ctx: &'a mut Self::Ctx, ) -> BoxFuture<'a, TernResult<Query>>

Produce a future resolving to the migration query when awaited.

Provided Methods

fn version(&self) -> i64

The migration version.

fn to_applied( &self, duration_ms: i64, applied_at: DateTime<Utc>, ) -> AppliedMigration

Convert this migration to an AppliedMigration assuming that it was successfully applied.

Implementors