Struct sqlx_migrate::Migration

pub struct Migration<DB: Database> { /* private fields */ }

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

impl<DB: Database> Migration<DB>

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

Set a down migration function.

pub fn revertible(
    self,
    down: impl for<'future> Fn(&'future mut Transaction<'_, DB>) -> LocalBoxFuture<'future, Result<(), MigrationError>> + 'static
) -> Self

Same as Migration::reversible

pub fn with_checksum(self, checksum: impl Into<Cow<'static, [u8]>>) -> Self

Set a checksum for the migration.

A checksum is only useful for migrations that come from external sources.

pub fn name(&self) -> &str

Get the migration’s name.

pub fn checksum(&self) -> &[u8]

Get a reference to the migration’s checksum.

pub fn is_reversible(&self) -> bool

Whether the migration is reversible or not.

pub fn is_revertible(&self) -> bool

Whether the migration is reversible or not.

Trait Implementations

impl<DB: Database> PartialEq<Migration<DB>> for Migration<DB>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<DB: Database> Eq for Migration<DB>