Awesome
Alt.FluentMigrator.VStudio
FluentMigrator is a SQL migration framework designed to help version an application's database. This package allows a developer to create a new migration, update or rollback database within Visual Studio's Package Manager console.
What is Alt.FluentMigrator.VStudio?
Alt.FluentMigrator.VStudio is a set of commands for Package Manager console which makes much easier and faster work with Fluent migrations.
It contains settings file:
- migrations.json
and following commands:
- Add-FluentMigration
- Update-FluentDatabase
- Rollback-FluentDatabase
How to install?
Please install FluentMigrator first. Required packages: FluentMigrator and FluentMigrator.Console.
Select Default project in Package Manager console and then install Alt.FluentMigrator.VStudio by command:
PM > Install-Package Alt.FluentMigrator.VStudio
Manually create required migrations.json file which contains settings. Please update it.
How to configurate migrations.json?
Example:
{
"ConnectionProjectName": "ConsoleApp",
"ConnectionName": "TestDb",
"FluentMigrationToolPath": ".\\packages\\FluentMigrator.Console.3.2.7\\tools\\net461\\x86\\Migrate.exe",
"DbProvider": "SqlServer",
"DbProviderHelpUrl": "https://fluentmigrator.github.io/articles/runners/runner-console.html#--provider---dbtype---dbvalue-required",
"MigrationFolder": "Migrations",
"ScriptsFolder": "Scripts",
"TimeFormat": "yyyyMMddHHmmss"
}
- ConnectionProjectName - name of the project in your solution which contains Web.config or App.config file with connection string.
- ConnectionName - specify connection name what you want to use.
- FluentMigrationToolPath - relative path to FluentMigrator tool.<br> Supports %USERPROFILE% variable for .NET Core projects. Example:
{
"FluentMigrationToolPath": "%USERPROFILE%\\.nuget\\packages\\fluentmigrator.console\\3.3.2\\net461\\any\\Migrate.exe",
}
- DbProvider - database provider. It is a parameter for FluentMigrator: --provider, --dbtype, --db=VALUE
- DbProviderHelpUrl - url on documentation.
- MigrationFolder - folder name in your project where all migrations will be created. it also supports subfolders. 'Migrations' by default.
- ScriptsFolder - folder name for sql scripts.
- TimeFormat - time format is a number which will be used for migration number and part of the file name. Time format "yyMMddHHmm" also applicable but contains less characters.
Add-FluentMigration
This command generates a new empty migration with a number based on current time with specified time format in migrations.json.
Add-FluentMigration [-MigrationName] <string> [[-AddScript]] [[-ProjectName] <string>]
Parameters
- -MigrationName <string> - required. Specifies migration name.
- -AddScript <SwitchParameter> - optional. Specifies whether sql file will be created in script folder.
- -ProjectName <string> - optional. Specifies the project where migrations and scripts will be created. If omitted, the default project selected in package manager console is used.
Example
PM > Add-FluentMigration InitialMigration -AddScript
It creates a migration folder if it does not exist. And it creates a script folder because of -AddScript parameter. The migration file will look like this:
using FluentMigrator;
namespace DbMigrations.Migrations
{
[Migration(20191207222856)]
public class InitialMigration : Migration
{
public override void Up()
{
Execute.Script(@"Scripts\20191207222856_InitialMigration.sql");
}
public override void Down()
{
Execute.Script(@"Scripts\20191207222856_InitialMigration_Down.sql");
}
}
}
Update-FluentDatabase
This command will apply all recently created migrations.
PM > Update-FluentDatabase [[-Script]] [[-Timeout]<int>]
Parameters
- -Script - optional. Specifies whether you only want to get the script and not run it.
- -Timeout - optional. The waiting time that is established. Default value 30 seconds.
If your migration takes a long time and you need to extend it, you can specify -Timeout parameter to 120
PM > Update-FluentDatabase -Timeout 120
Rollback-FluentDatabase
This command will revert all migrations to specified version (migration number).
Parameters
- -Script - optional. Specifies whether you only want to get the script and not run it.
- -Timeout - optional. The waiting time that is established. Default value 30 seconds.
PM > Rollback-FluentDatabase 20191207220215