Trait Migration

pub trait Migration<DB: Backend> {
    // Required methods
    fn run(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>;
    fn revert(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>;
    fn metadata(&self) -> &dyn MigrationMetadata;
    fn name(&self) -> &dyn MigrationName;
}

Represents a migration that interacts with diesel

Required Methods

fn run(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

Apply this migration

fn revert(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

Revert this migration

fn metadata(&self) -> &dyn MigrationMetadata

Get a the attached metadata for this migration

fn name(&self) -> &dyn MigrationName

Get the name of the current migration

The provided name is used by migration harness to get the version of a migration and to as something to that is displayed and allows user to identify a specific migration

Trait Implementations

impl<'a, DB: Backend> Migration<DB> for &'a dyn Migration<DB>

fn run(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

Apply this migration

fn revert(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

Revert this migration

fn metadata(&self) -> &dyn MigrationMetadata

Get a the attached metadata for this migration

fn name(&self) -> &dyn MigrationName

Get the name of the current migration

impl<'a, DB: Backend> Migration<DB> for Box<dyn Migration<DB> + 'a>

fn run(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

Apply this migration

fn revert(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

Revert this migration

fn metadata(&self) -> &dyn MigrationMetadata

Get a the attached metadata for this migration

fn name(&self) -> &dyn MigrationName

Get the name of the current migration

Implementations on Foreign Types

impl<'a, DB: Backend> Migration<DB> for Box<dyn Migration<DB> + 'a>

fn run(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

fn revert(&self, conn: &mut dyn BoxableConnection<DB>) -> Result<()>

fn metadata(&self) -> &dyn MigrationMetadata

fn name(&self) -> &dyn MigrationName

Implementors

impl<'a, DB: Backend> Migration<DB> for &'a dyn Migration<DB>