Struct migrant_lib::migration::EmbeddedMigration

pub struct EmbeddedMigration {
    pub tag: String,
    pub up: Option<&'static str>,
    pub down: Option<&'static str>,
}

Define an embedded migration

SQL statements provided to EmbeddedMigration will be embedded in the executable so no files are required at run-time. The standard include_str! macro can be used to embed contents of files. Database specific features (d-postgres/d-sqlite/d-mysql) are required to use this functionality.

Example

EmbeddedMigration::with_tag("initial")?
    .up(include_str!("../migrations/embedded/initial/up.sql"))
    .down(include_str!("../migrations/embedded/initial/down.sql"));

Fields

tag: String

up: Option<&'static str>

down: Option<&'static str>

Methods

impl EmbeddedMigration

fn with_tag(tag: &str) -> Result<Self>

Create a new EmbeddedMigration with the given tag

Tags may contain [a-z0-9-]

fn up(&mut self, stmt: &'static str) -> &mut Self

Statement to use for up migrations

fn down(&mut self, stmt: &'static str) -> &mut Self

Statement to use for down migrations

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

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

Trait Implementations

impl Clone for EmbeddedMigration

fn clone(&self) -> EmbeddedMigration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddedMigration

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Migratable for EmbeddedMigration

fn apply_up(&self, _db_kind: DbKind, _config: &Config) -> Result<(), Box<Error>>

Define functionality that runs for up migrations

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

Define functionality that runs for down migrations

fn tag(&self) -> String

A unique identifying tag

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

Option migration description. Defaults to Migratable::tag