Struct migrant_lib::migration::FileMigration

pub struct FileMigration {
    pub tag: String,
    pub up: Option<PathBuf>,
    pub down: Option<PathBuf>,
    // some fields omitted
}

Define a migration that uses SQL statements saved in files.

Note: Files defined in this migration must be present at run-time. File paths can be absolute or relative. Relative file paths are relative to the directory from which the program is run.

Note: SQL statements are batch executed as is. If you want your migration to happen atomically in a transaction you should manually wrap your statements in a transaction (begin transaction; ... commit;).

Fields

tag: String

up: Option<PathBuf>

down: Option<PathBuf>

Implementations

impl FileMigration

pub fn with_tag(tag: &str) -> Self

Create a new FileMigration with a given tag

pub fn up<T: AsRef<Path>>(&mut self, up_file: T) -> Result<&mut Self>

Define the file to use for running up migrations.

Note: Files defined in this migration must be present at run-time. File paths can be absolute or relative. Relative file paths are relative to the directory from which the program is run.

pub fn down<T: AsRef<Path>>(&mut self, down_file: T) -> Result<&mut Self>

Define the file to use for running down migrations.

Note: Files defined in this migration must be present at run-time. File paths can be absolute or relative. Relative file paths are relative to the directory from which the program is run.

pub fn boxed(&self) -> Box<dyn Migratable>

Box this migration up so it can be stored with other migrations

Trait Implementations

impl Clone for FileMigration

fn clone(&self) -> FileMigration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileMigration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Migratable for FileMigration

fn apply_up(
    &self,
    db_kind: DbKind,
    config: &Config
) -> Result<(), Box<dyn Error>>

Define functionality that runs for up migrations

fn apply_down(
    &self,
    db_kind: DbKind,
    config: &Config
) -> Result<(), Box<dyn Error>>

Define functionality that runs for down migrations

fn tag(&self) -> String

A unique identifying tag

fn description(&self, direction: &Direction) -> String

Option migration description. Defaults to Migratable::tag