Struct migrant_lib::migration::EmbeddedMigration

pub struct EmbeddedMigration {
    pub tag: String,
    pub up: Option<Cow<'static, str>>,
    pub down: Option<Cow<'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, or a string literal can be provided.

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;).

Database specific features (d-postgres/d-sqlite/d-mysql) are required to use this functionality.

Example

EmbeddedMigration::with_tag("create-users-table")
    .up(include_str!("../migrations/embedded/create_users_table/up.sql"))
    .down(include_str!("../migrations/embedded/create_users_table/down.sql"));

EmbeddedMigration::with_tag("create-places-table")
    .up("create table places(id integer);")
    .down("drop table places;");

Fields

tag: String

up: Option<Cow<'static, str>>

down: Option<Cow<'static, str>>

Implementations

impl EmbeddedMigration

pub fn with_tag(_tag: &str) -> DatabaseFeatureRequired

Create a new EmbeddedMigration with the given tag

pub fn up<T: Into<Cow<'static, str>>>(&mut self, stmt: T) -> &mut Self

&'static str or String of statements to use for up migrations

pub fn down<T: Into<Cow<'static, str>>>(&mut self, stmt: T) -> &mut Self

&'static str or String of statements to use for down migrations

pub fn boxed(&self) -> Box<dyn 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, f: &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<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) -> String

Option migration description. Defaults to Migratable::tag