Struct sqlx_migrate::Migration [−][src]
pub struct Migration<DB: Database> { /* fields omitted */ }
Expand description
A single migration that uses a given [sqlx::Transaction
] to do the up (migrate) and down (revert) migrations.
Example
use sqlx_migrate::Migration;
use sqlx::{Executor, Postgres};
let migration = Migration::<Postgres>::new("initial migration", |tx| {
Box::pin(async move {
tx.execute("CREATE TABLE example ();").await?;
Ok(())
})
})
// Low-effort (optional) checksum.
.with_checksum(b"CREATE TABLE example ();".as_slice())
.reversible(|tx| {
Box::pin(async move {
tx.execute("DROP TABLE example;");
Ok(())
})
});
Implementations
pub fn new(
name: impl Into<Cow<'static, str>>,
up: impl for<'future> Fn(&'future mut Transaction<'_, DB>) -> LocalBoxFuture<'future, Result<(), MigrationError>> + 'static
) -> Self
pub fn new(
name: impl Into<Cow<'static, str>>,
up: impl for<'future> Fn(&'future mut Transaction<'_, DB>) -> LocalBoxFuture<'future, Result<(), MigrationError>> + 'static
) -> Self
Create a new migration with the given name and migration function.
pub fn reversible(
self,
down: impl for<'future> Fn(&'future mut Transaction<'_, DB>) -> LocalBoxFuture<'future, Result<(), MigrationError>> + 'static
) -> Self
pub fn reversible(
self,
down: impl for<'future> Fn(&'future mut Transaction<'_, DB>) -> LocalBoxFuture<'future, Result<(), MigrationError>> + 'static
) -> Self
Set a down migration function.
Set a checksum for the migration.
A checksum is only useful for migrations that come from external sources.
Get a reference to the migration’s checksum.
Whether the migration is reversible or not.
Trait Implementations
Auto Trait Implementations
impl<DB> !RefUnwindSafe for Migration<DB>
impl<DB> !UnwindSafe for Migration<DB>
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more