Struct MigratorBuilder 

pub struct MigratorBuilder { /* private fields */ }

Builds a Migrator while computing expected schema hashes on an in-memory database.

use miden_node_db::migration::{Migrator, SchemaHash};
use rusqlite::Transaction;

fn add_item_height(tx: &Transaction<'_>) -> anyhow::Result<()> {
    tx.execute_batch("ALTER TABLE items ADD COLUMN height INTEGER;")?;
    Ok(())
}

fn migrator() -> anyhow::Result<Migrator> {
    Migrator::builder()?
        .push_retired(
            "001_create_items",
            "CREATE TABLE items (id INTEGER PRIMARY KEY, value TEXT);",
        )?
        .push_sql("002_index_items", "CREATE INDEX idx_items_value ON items(value);")?
        .push_code("003_add_item_height", add_item_height)?
        .build()
}

const EXPECTED_SCHEMA_HASHES: [SchemaHash; 3] = [
    SchemaHash::from_hex(
        "1111111111111111111111111111111111111111111111111111111111111111",
    ),
    SchemaHash::from_hex(
        "2222222222222222222222222222222222222222222222222222222222222222",
    ),
    SchemaHash::from_hex(
        "3333333333333333333333333333333333333333333333333333333333333333",
    ),
];

#[test]
fn migration_schema_hashes_are_stable() -> anyhow::Result<()> {
    let migrator = migrator()?;

    assert_eq!(migrator.schema_hashes(), &EXPECTED_SCHEMA_HASHES);
    Ok(())
}

Implementations

impl MigratorBuilder

pub fn push_retired(self, name: &'static str, sql: &'static str) -> Result<Self>

Adds a pure SQL retired migration.

Retired migrations initialize fresh databases from SQL that replaces old active migrations. They must be pushed before any active migration.

pub fn push_sql(self, name: &'static str, sql: &'static str) -> Result<Self>

Adds a SQL migration that remains supported for existing databases.

pub fn push_code( self, name: &'static str, apply: CodeMigrationFn, ) -> Result<Self>

Adds a Rust migration function.

pub fn build(self) -> Result<Migrator>

Returns a migrator containing all migrations and their expected schema hashes.