Struct MigrationRunner 

pub struct MigrationRunner<D: MigrationDialect> { /* private fields */ }

Runs migrations in dependency order.

The runner tracks which migrations are registered and uses the provided MigrationState to determine which migrations need to be applied.

Example

use oxide_sql_core::migrations::{
    Migration, MigrationRunner, MigrationState, Operation,
    CreateTableBuilder, SqliteDialect, bigint,
};

// Define a migration
pub struct Migration0001;
impl Migration for Migration0001 {
    const ID: &'static str = "0001_initial";
    fn up() -> Vec<Operation> {
        vec![CreateTableBuilder::new()
            .name("test")
            .column(bigint("id").primary_key().build())
            .build()
            .into()]
    }
    fn down() -> Vec<Operation> {
        vec![Operation::drop_table("test")]
    }
}

// Create runner
let mut runner = MigrationRunner::new(SqliteDialect::new());
runner.register::<Migration0001>();

// Check status
let state = MigrationState::new();
let pending = runner.pending_migrations(&state);
assert_eq!(pending.len(), 1);

Implementations

impl<D: MigrationDialect> MigrationRunner<D>

pub fn new(dialect: D) -> Self

Creates a new migration runner with the given dialect.

pub fn register<M: Migration>(&mut self) -> &mut Self

Registers a migration.

pub fn migrations(&self) -> &[RegisteredMigration]

Returns all registered migrations.

pub fn dialect(&self) -> &D

Returns the dialect.

pub fn pending_migrations( &self, state: &MigrationState, ) -> Vec<&RegisteredMigration>

Returns migrations that haven’t been applied yet.

pub fn status(&self, state: &MigrationState) -> Vec<MigrationStatus>

Returns the status of all migrations.

pub fn sorted_migrations( &self, ) -> Result<Vec<&RegisteredMigration>, MigrationError>

Returns migrations in dependency order (topological sort).

Returns Err if there’s a circular dependency.

pub fn sql_for_pending( &self, state: &MigrationState, ) -> Result<Vec<(&'static str, Vec<String>)>, MigrationError>

Generates SQL for all pending migrations.

Returns a list of (migration_id, sql_statements) pairs.

pub fn sql_for_rollback( &self, state: &MigrationState, count: usize, ) -> Result<Vec<(&'static str, Vec<String>)>, MigrationError>

Generates SQL for rolling back migrations.

Returns a list of (migration_id, sql_statements) pairs in reverse order.

pub fn validate(&self) -> Result<(), MigrationError>

Validates that all dependencies exist and are registered.