sea-orm-migration 2.0.0-rc.38

Migration utility for SeaORM
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

#[cfg(feature = "cli")]
pub mod cli;
pub mod connection;
pub mod manager;
pub mod migrator;
pub mod prelude;
pub mod schema;
pub mod seaql_migrations;
pub mod util;

pub use connection::*;
pub use manager::*;
pub use migrator::*;

pub use async_trait;
pub use sea_orm;
pub use sea_orm::DbErr;
pub use sea_orm::sea_query;

pub trait MigrationName {
    fn name(&self) -> &str;
}

/// The migration definition
#[async_trait::async_trait]
pub trait MigrationTrait: MigrationName + Send + Sync {
    /// Define actions to perform when applying the migration
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr>;

    /// Define actions to perform when rolling back the migration
    async fn down(&self, _manager: &SchemaManager) -> Result<(), DbErr> {
        Err(DbErr::Migration("We Don't Do That Here".to_owned()))
    }

    /// Control whether this migration runs inside a transaction.
    ///
    /// - `None` (default): follow backend convention (Postgres = transaction, MySQL/SQLite = no transaction)
    /// - `Some(true)`: force wrapping in a transaction on any backend
    /// - `Some(false)`: disable automatic transaction wrapping (use `manager.begin()` for manual control)
    fn use_transaction(&self) -> Option<bool> {
        None
    }
}