How can I run Entity Framework's migrate.exe from Visual Studio Online?

Question

I have set up continuous integration for my project with Visual Studio Online build definitions.

When it comes to deploying my database (to an Azure test environment) I just build my SQL Server Database Project with the right publishing settings.

But I want to switch to Entity Framework's code first approach and leverage the migration feature, which requires me to call migrate.exe.

My question is - how could I run migrate.exe from VSO build definitions?

Answer 1

We've succesfully implemented an automated EF code first migration at deploy time on top of TFS Build vNext in the following way:

It basically involves 3 steps (per EF-context):

1. Copy EF-project to a staging directory
2. Copy migrate.exe in same folder (migrate.exe requires to be placed right next to assembly containing EF migrations)
3. Execute migrate.exe

In detail:

1. Copy Files "task"
   • Source folder: $(build.sourcesdirectory)
   • Contents: Contoso.EF\bin\debug\ **
   • Target folder: $(build.artifactstagingdirectory)/EF
2. Copy Files "task"
   • Source folder: $(build.sourcesDirectory)\packages\EntityFramework.6.1.3\tools
   • Contents: migrate.exe
   • Target folder: $(build.artifactstagingdirectory)\EF\Contoso.EF\bin\debug\bin\debug
3. Batch script "task"
   • Path: $(build.sourcesdirectory)_Deploy\MigrateEFContext.bat
   • Arguments: $(build.artifactstagingdirectory)\EF\Contoso.EF\bin\debug Contoso.EF.dll [SQL-SERVER-INSTANCE] [DbName] System.Data.SqlClient

The MigrateEFContext.bat file assembles the migrate.exe-command with its arguments:

SET EFDir=%1
SET EFContext=%2
SET connStringDataSource=%3
SET connStringInitialCatalog=%4
SET connectionProviderName=%5

%EFDIR%\migrate.exe %EFContext% /ConnectionString:"Data Source=%connStringDataSource%;Initial Catalog=%connStringInitialCatalog%;Integrated Security=true" /connectionProviderName:%connectionProviderName% /verbose