Struct butane_core::migrations::FsMigration

pub struct FsMigration { /* private fields */ }

A migration stored in the filesystem

Implementations

impl FsMigration

pub fn copy_to(&self, other: &mut Self) -> Result<()>

Trait Implementations

impl Debug for FsMigration

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

Formats the value using the given formatter.

impl Migration for FsMigration

fn db(&self) -> Result<ADB>

Retrieves the full abstract database state describing all tables

fn migration_from(&self) -> Result<Option<Cow<'_, str>>>

Get the name of the migration before this one (if any).

fn name(&self) -> Cow<'_, str>

The name of this migration.

fn up_sql(&self, backend_name: &str) -> Result<Option<String>>

The backend-specific commands to apply this migration.

fn down_sql(&self, backend_name: &str) -> Result<Option<String>>

The backend-specific commands to undo this migration.

fn sql_backends(&self) -> Result<Vec<String>>

The names of the backends this migration has sql for.

fn apply(&self, conn: &mut impl BackendConnection) -> Result<()>

Apply the migration to a database connection. The connection must be for the same type of database as this and the database must be in the state of the migration prior to this one

fn mark_applied(&self, conn: &impl ConnectionMethods) -> Result<()>

Mark the migration as being applied without doing any work. Use carefully – the caller must ensure that the database schema already matches that expected by this migration.

fn downgrade(&self, conn: &mut impl BackendConnection) -> Result<()>

Un-apply (downgrade) the migration to a database connection. The connection must be for the same type of database as this and this must be the latest migration applied to the database.

impl MigrationMut for FsMigration

fn set_migration_from(&mut self, prev: Option<String>) -> Result<()>

Set the migration before this one.

fn write_table(&mut self, table: &ATable) -> Result<()>

Adds an abstract table to the migration. The table state should represent the expected state after the migration has been applied. It is expected that all tables will be added to the migration in this fashion.

fn delete_table(&mut self, table: &str) -> Result<()>

Delete the table with the given name. Note that simply deleting a table in code does not work – it will remain with its last known schema unless explicitly deleted. See also the butane cli command butane delete table <TABLE>.

fn add_sql( &mut self, backend_name: &str, up_sql: &str, down_sql: &str ) -> Result<()>

Set the backend-specific commands to apply/undo this migration.

fn add_type(&mut self, key: TypeKey, sqltype: DeferredSqlType) -> Result<()>

Adds a TypeKey -> SqlType mapping. Only meaningful on the special current migration.

impl PartialEq<FsMigration> for FsMigration

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FsMigration