diff --git a/Libraries/Migrator.NET/Migrator.Framework.dll b/Libraries/Migrator.NET/Migrator.Framework.dll index 97ceaeea3..5d62387c9 100644 Binary files a/Libraries/Migrator.NET/Migrator.Framework.dll and b/Libraries/Migrator.NET/Migrator.Framework.dll differ diff --git a/Libraries/Migrator.NET/Migrator.Framework.xml b/Libraries/Migrator.NET/Migrator.Framework.xml index 41fba991d..4002f9f26 100644 --- a/Libraries/Migrator.NET/Migrator.Framework.xml +++ b/Libraries/Migrator.NET/Migrator.Framework.xml @@ -4,123 +4,43 @@ 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. + Describe a migration - + - This is run after the Up transaction has been committed + Describe the migration + The unique version of the migration. - + - Defines transformations to revert things done in Up. + The version reflected by the migration - + - This is run after the Down transaction has been committed + Set to true to ignore this migration. - + - This gets called once on the first migration object. + Convert a classname to something more readable. + ex.: CreateATable => Create a table + + - + - Represents the database. - . + - Migration.Framework.ITransformationProvider + + + + @@ -211,149 +131,6 @@ 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. @@ -853,6 +630,109 @@ Logger used to log details of operations performed during migration + + + 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. + + + + 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 + + + + 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 + + ILogger interface. @@ -877,6 +757,116 @@ Represents a table column. + + + Base class for migration errors. + + + + + Handles writing a message to the log medium (i.e. file, console) + + + + + Write this message + + + + + + + Write this message, as a line + + + + + + + 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 + Adds a Table to be created to the Schema @@ -905,6 +895,16 @@ Column name to be added IColumnOptions to restrict chaining + + + 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. + + Text logger for the migration mediator diff --git a/Libraries/Migrator.NET/Migrator.Providers.dll b/Libraries/Migrator.NET/Migrator.Providers.dll index f9d6f65ec..89e3d8106 100644 Binary files a/Libraries/Migrator.NET/Migrator.Providers.dll and b/Libraries/Migrator.NET/Migrator.Providers.dll differ