Struct butane_core::migrations::FsMigrations

pub struct FsMigrations { /* fields omitted */ }

A collection of migrations stored in the filesystem.

Implementations

impl FsMigrations

pub fn new(root: PathBuf) -> Self

Trait Implementations

impl Migrations for FsMigrations

type M = FsMigration

pub fn get_migration(&self, name: &str) -> Option<Self::M>

Gets the migration with the given name, if it exists

pub fn latest(&self) -> Option<Self::M>

Get the most recent migration (other than current) or None if no migrations have been created.

pub fn migrations_since(&self, since: &Self::M) -> Result<Vec<Self::M>>

Returns migrations since the given migration.

pub fn all_migrations(&self) -> Result<Vec<Self::M>>

Returns all migrations

pub fn unapplied_migrations(
    &self,
    conn: &impl ConnectionMethods
) -> Result<Vec<Self::M>>

Get migrations which have not yet been applied to the database

pub fn last_applied_migration(
    &self,
    conn: &impl ConnectionMethods
) -> Result<Option<Self::M>>

Get the last migration that has been applied to the database or None if no migrations have been applied

impl MigrationsMut for FsMigrations

pub fn current(&mut self) -> &mut Self::M

Get a pseudo-migration representing the current state as determined by the last build of models. This does not necessarily match the current state of the database if migrations have not yet been applied.

pub fn new_migration(&self, name: &str) -> Self::M

pub fn add_migration(&mut self, m: Self::M) -> Result<()>

pub fn create_migration(
    &mut self,
    backend: &impl Backend,
    name: &str,
    from: Option<&Self::M>
) -> Result<bool>

Create a migration from -> current named name. From may be None, in which case the migration is created from an empty database. Returns true if a migration was created, false if from and current represent identical states.