Trait sea_orm_migration::migrator::MigratorTrait

pub trait MigratorTrait: Send {
    fn migrations() -> Vec<Box<dyn MigrationTrait>> ;

    fn get_migration_files() -> Vec<Migration>  { ... }
    fn get_migration_models<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Model>, DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn get_migration_with_status<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Migration>, DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn get_pending_migrations<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Migration>, DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn get_applied_migrations<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Migration>, DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn install<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
    { ... }
    fn fresh<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn refresh<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn reset<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn status<'life0, 'async_trait>(
        db: &'life0 DbConn
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn up<'life0, 'async_trait>(
        db: &'life0 DbConn,
        steps: Option<u32>
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
    fn down<'life0, 'async_trait>(
        db: &'life0 DbConn,
        steps: Option<u32>
    ) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
}

Performing migrations on a database

Required Methods

fn migrations() -> Vec<Box<dyn MigrationTrait>>

Vector of migrations in time sequence

Provided Methods

fn get_migration_files() -> Vec<Migration>

Get list of migrations wrapped in Migration struct

fn get_migration_models<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<Vec<Model>, DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get list of applied migrations from database

fn get_migration_with_status<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<Vec<Migration>, DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get list of migrations with status

fn get_pending_migrations<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<Vec<Migration>, DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get list of pending migrations

fn get_applied_migrations<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<Vec<Migration>, DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get list of applied migrations

fn install<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    'life0: 'async_trait,

Create migration table seaql_migrations in the database

fn fresh<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Drop all tables from the database, then reapply all migrations

fn refresh<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Rollback all applied migrations, then reapply all migrations

fn reset<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Rollback all applied migrations

fn status<'life0, 'async_trait>(
    db: &'life0 DbConn
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Check the status of all migrations

fn up<'life0, 'async_trait>(
    db: &'life0 DbConn,
    steps: Option<u32>
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Apply pending migrations

fn down<'life0, 'async_trait>(
    db: &'life0 DbConn,
    steps: Option<u32>
) -> Pin<Box<dyn Future<Output = Result<(), DbErr>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Rollback applied migrations

Implementors