Migrating projects with custom Migration Log name properties
Published 07 June 2018
Customizing the names of the Migration Log table and Migration Log view is now deprecated, and support for the following project settings has been removed:
<PropertyGroup>
<MigrationLogTableName>MyMigrationLog</MigrationLogTableName>
<MigrationLogViewName>MyMigrationLogCurrent</MigrationLogViewName>
</PropertyGroup>
If you have any projects that are currently using the above settings, you will need to adapt your project to use the MigrationLogSchemaName setting. This means that your migration log table and view objects will always be named __MigrationLog and __MigrationLogCurrent respectively, however the schema in which they are contained will still be customizable.
Once you have removed the MigrationLogTableName and MigrationLogViewName settings from your sqlproj file, and added the MigrationLogSchemaName setting, you will need to move your existing migration log table to the newly-defined schema.
Adapting existing projects can be accomplished by performing the following steps:
- Open your SQL Change Automation project in Visual Studio
- In the Solution Explorer, right-click the project and select Unload Project.
- In the document window, remove the <MigrationLogTableName> and <MigrationLogViewName> elements, and add the <MigrationLogSchemaName> property in their place:
<PropertyGroup>
<MigrationLogSchemaName>MySchema</MigrationLogSchemaName>
</PropertyGroup> - Save and right-click the project and select Reload Project.
- In the Solution Explorer, right-click the Pre-Deployment folder and select Add Script
- This script should run after 01_Create_Database.sql, so give it a name like 02_Move_MigrLog_to_Schema.sql
- Paste the below code into the script window
- Replace the values of the variables in the header of the script as appropriate. OldMigrationLogSchema should be left as "dbo" unless you had previously customised the schema name. OldMigrationLogTableName should use the value of the <MigrationLogTableName> (former) sqlproj setting, OldMigrationLogViewName should use the value of <MigrationLogViewName>, and NewMigrationLogSchemaName should use the value of <MigrationLogSchemaName>.
- Click Build... Deploy solution
In the Output window, look for the following message:
Successfully moved migration objects
If this message does not appear, check that the variables are set correctly and try again. Note that you may receive the following error after this message:
This script "Migrations\0001_<<scriptSuffix>>.sql" has already been executed within the "<<DatabaseName>>" database on this server. Halting deployment.
However, the migration object move should have succeeded in spite of this message, and the error should not appear during subsequent deployment attempts. If the error reappears, check that the NewMigrationLogSchemaName is set to the correct value.
Content of Pre-Deployment\02_Move_MigrLog_to_Schema.sql:
:setvar OldMigrationLogSchema "dbo" :setvar OldMigrationLogTableName "__MigrationLog" :setvar OldMigrationLogViewName "__MigrationLogCurrent" :setvar NewMigrationLogSchemaName "MyMigrationObjSchema" GO USE [$(DatabaseName)] BEGIN TRANSACTION IF OBJECT_ID('[$(NewMigrationLogSchemaName)].[__MigrationLog]', 'U') IS NULL AND OBJECT_ID('[$(OldMigrationLogSchema)].[$(OldMigrationLogTableName)]', 'U') IS NOT NULL BEGIN IF SCHEMA_ID(N'$(NewMigrationLogSchemaName)') IS NULL EXEC sp_executesql N'CREATE SCHEMA [$(NewMigrationLogSchemaName)] AUTHORIZATION [dbo]' ALTER SCHEMA [$(NewMigrationLogSchemaName)] TRANSFER [$(OldMigrationLogSchema)].[$(OldMigrationLogTableName)] ALTER SCHEMA [$(NewMigrationLogSchemaName)] TRANSFER [$(OldMigrationLogSchema)].[$(OldMigrationLogViewName)] IF OBJECT_ID(N'[$(OldMigrationLogSchema)].[__SchemaSnapshot]', 'U') IS NOT NULL ALTER SCHEMA [$(NewMigrationLogSchemaName)] TRANSFER [$(OldMigrationLogSchema)].[__SchemaSnapshot] PRINT N'Dropping [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)].[IX_$(OldMigrationLogTableName)_CompleteDt]...'; DROP INDEX [IX_$(OldMigrationLogTableName)_CompleteDt] ON [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]; PRINT N'Dropping [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)].[IX_$(OldMigrationLogTableName)_Version]...'; DROP INDEX [IX_$(OldMigrationLogTableName)_Version] ON [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]; PRINT N'Dropping [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)].[UX_$(OldMigrationLogTableName)_SequenceNo]...'; DROP INDEX [UX_$(OldMigrationLogTableName)_SequenceNo] ON [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]; PRINT N'Dropping [$(NewMigrationLogSchemaName)].[DF_$(OldMigrationLogTableName)_deployed]...'; ALTER TABLE [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)] DROP CONSTRAINT [DF_$(OldMigrationLogTableName)_deployed]; PRINT N'Creating [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)].[IX___MigrationLog_CompleteDt]...'; CREATE NONCLUSTERED INDEX [IX___MigrationLog_CompleteDt] ON [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]([complete_dt] ASC); PRINT N'Creating [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)].[IX___MigrationLog_Version]...'; CREATE NONCLUSTERED INDEX [IX___MigrationLog_Version] ON [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]([version] ASC); PRINT N'Creating [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)].[UX___MigrationLog_SequenceNo]...'; CREATE UNIQUE NONCLUSTERED INDEX [UX___MigrationLog_SequenceNo] ON [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]([sequence_no] ASC); PRINT N'Creating [$(NewMigrationLogSchemaName)].[DF___MigrationLog_deployed]...'; ALTER TABLE [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)] ADD CONSTRAINT [DF___MigrationLog_deployed] DEFAULT ((1)) FOR [deployed]; PRINT N'Rename [$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)] to __MigrationLog'; EXECUTE sp_rename @objname = N'[$(NewMigrationLogSchemaName)].[$(OldMigrationLogTableName)]', @newname = N'__MigrationLog', @objtype = N'OBJECT'; PRINT N'Rename [$(NewMigrationLogSchemaName)].[$(OldMigrationLogViewName)] to __MigrationLogCurrent'; EXECUTE sp_rename @objname = N'[$(NewMigrationLogSchemaName)].[$(OldMigrationLogViewName)]', @newname = N'__MigrationLogCurrent', @objtype = N'OBJECT'; ALTER TABLE [$(NewMigrationLogSchemaName)].[__MigrationLog] DROP CONSTRAINT [PK_$(OldMigrationLogTableName)] ALTER TABLE [$(NewMigrationLogSchemaName)].[__MigrationLog] ADD CONSTRAINT [PK___MigrationLog] PRIMARY KEY CLUSTERED ( migration_id, complete_dt, script_checksum ) PRINT N'Altering [$(NewMigrationLogSchemaName)].[__MigrationLogCurrent]...'; EXEC (' ALTER VIEW [$(NewMigrationLogSchemaName)].[__MigrationLogCurrent] AS WITH currentMigration AS ( SELECT migration_id, script_checksum, script_filename, complete_dt, applied_by, deployed, ROW_NUMBER() OVER(PARTITION BY migration_id ORDER BY sequence_no DESC) AS RowNumber FROM [$(NewMigrationLogSchemaName)].[__MigrationLog] ) SELECT migration_id, script_checksum, script_filename, complete_dt, applied_by, deployed FROM currentMigration WHERE RowNumber = 1 '); PRINT 'Successfully moved migration objects to the [$(NewMigrationLogSchemaName)] schema' END COMMIT TRANSACTION