Struct MigrationManager

pub struct MigrationManager { /* private fields */ }

Migration manager for handling database schema changes

The central component for managing database migrations. Handles initialization, execution, and tracking of schema changes.

Examples

use libsql_orm::{MigrationManager, Database};

async fn setup_migrations(db: Database) -> Result<(), Error> {
    let manager = MigrationManager::new(db);
     
    // Initialize migration tracking
    manager.init().await?;
     
    // Get migration status
    let executed = manager.get_executed_migrations().await?;
    let pending = manager.get_pending_migrations().await?;
     
    println!("Executed: {}, Pending: {}", executed.len(), pending.len());
    Ok(())
}

Implementations

impl MigrationManager

pub fn new(db: Database) -> Self

Create a new migration manager

pub async fn init(&self) -> Result<(), Error>

Initialize the migration table

pub fn create_migration(name: &str, sql: &str) -> Migration

Create a new migration

pub async fn get_migrations(&self) -> Result<Vec<Migration>, Error>

Get all migrations from the database

pub async fn execute_migration( &self, migration: &Migration, ) -> Result<(), Error>

Execute a migration

pub async fn rollback_migration(&self, migration_id: &str) -> Result<(), Error>

Rollback a migration

pub async fn get_pending_migrations(&self) -> Result<Vec<Migration>, Error>

Get pending migrations (not yet executed)

pub async fn get_executed_migrations(&self) -> Result<Vec<Migration>, Error>

Get executed migrations

pub async fn run_migrations( &self, migrations: Vec<Migration>, ) -> Result<(), Error>

Run all pending migrations

pub async fn create_migration_from_file( name: &str, file_path: &str, ) -> Result<Migration, Error>

Create a migration from a file

pub fn generate_migration_name(description: &str) -> String

Generate a migration name from a description

pub fn database(&self) -> &Database