Migrator.Framework

A migration is a group of transformation applied to the database schema (or sometimes data) to port the database from one version to another. The Up() method must apply the modifications (eg.: create a table) and the Down() method must revert, or rollback the modifications (eg.: delete a table). Each migration must be decorated with the [Migration(0)] attribute. Each migration number (0) must be unique, or else a DuplicatedVersionException will be trown. All migrations are executed inside a transaction. If an exception is thrown, the transaction will be rolledback and transformations wont be applied. It is best to keep a limited number of transformation inside a migration so you can easely move from one version of to another with fine grain modifications. You should give meaningful name to the migration class and prepend the migration number to the filename so they keep ordered, eg.: 002_CreateTableTest.cs. Use the Database property to apply transformation and the Logger property to output informations in the console (or other). For more details on transformations see ITransformationProvider.

The following migration creates a new Customer table. (File 003_AddCustomerTable.cs)


            [Migration(3)]
            public class AddCustomerTable : Migration
            {
            	public override void Up()
            	{
            		Database.AddTable("Customer",
            	                  new Column("Name", typeof(string), 50),
            	                  new Column("Address", typeof(string), 100)
            	                 );
            	}
            	public override void Down()
            	{
            		Database.RemoveTable("Customer");
            	}
            }

Defines tranformations to port the database to the current version.

This is run after the Up transaction has been committed

Defines transformations to revert things done in Up.

This is run after the Down transaction has been committed

This gets called once on the first migration object.

Represents the database. .

Migration.Framework.ITransformationProvider

Defines tranformations to port the database to the current version.

This is run after the Up transaction has been committed

Defines transformations to revert things done in Up.

This is run after the Down transaction has been committed

This gets called once on the first migration object.

Represents the database. .

Migration.Framework.ITransformationProvider

Log that we have started a migration

Start list of versions Final Version

Log that we are migrating up

Version we are migrating to Migration name

Log that we are migrating down

Version we are migrating to Migration name

Inform that a migration corresponding to the number of version is untraceable (not found?) and will be ignored.

Version we couldnt find

Log that we are rolling back to version

version

Log a Sql statement that changes the schema or content of the database as part of a migration

SELECT statements should not be logged using this method as they do not alter the data or schema of the database. The Sql statement to log

Log that we had an exception on a migration

The version of the migration that caused the exception. The name of the migration that caused the exception. The exception itself

Log that we had an exception on a migration

An informative message to show to the user. The exception itself

Log that we have finished a migration

List of versions with which we started Final Version

Log a message

The format string ("{0}, blabla {1}"). Parameters to apply to the format string.

Log a Warning

The format string ("{0}, blabla {1}"). Parameters to apply to the format string.

Log a Trace Message

The format string ("{0}, blabla {1}"). Parameters to apply to the format string.

Base class for migration errors.

Return the plural of a word.

The singular form The plural form of

Return the singular of a word.

The plural form The singular form of

Capitalizes a word.

The word to be capitalized. capitalized.

Convert a classname to something more readable. ex.: CreateATable => Create a table

Handles writing a message to the log medium (i.e. file, console)

Write this message

Write this message, as a line

Represents a table column properties.

Null is allowable

Null is not allowable

Identity column, autoinc

Unique Column

Indexed Column

Unsigned Column

Foreign Key

Primary Key

Primary key. Make the column a PrimaryKey and unsigned

A set of extension methods for the transformation provider to make it easier to build many-to-many joining tables (takes care of adding the joining table and foreign key constraints as necessary. This functionality was useful when bootstrapping a number of projects a few years ago, but now that most changes are brown-field I'm thinking of removing these methods as it's easier to maintain code that creates the tables etc. directly within migration.

Describe a migration

Describe the migration

The unique version of the migration.

The version reflected by the migration

Set to true to ignore this migration.

The main interface to use in Migrations to make changes on a database schema.