Merge pull request #66 from webmd-health-services/feature/Checkpoint-…

…Migration-Revision Feature/checkpoint migration revision
webmd-health-services · Apr 3, 2023 · 665ae20 · 665ae20
2 parents 5ef5abf + a7f3ed1
commit 665ae20
Show file tree

Hide file tree

Showing 10 changed files with 435 additions and 225 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,14 @@
 <!--markdownlint-disable MD012 no-multiple-blanks -->
 <!--markdownlint-disable MD024 no-duplicate-heading/no-duplicate-header -->
 
+# 0.19.0
+
+* `Checkpoint-Migration` will no longer delete migration scripts that have been pushed to the database. Instead it
+  will now export rows from the `rivet.Migrations` table and include them in the `schema.ps1` file.
+* Added an `InitializeSchema` switch to the `Invoke-Rivet` script that is used to initialize database(s) with the
+  `schema.ps1` file that is generated from `Checkpoint-Migration`.
+
+
 # 0.18.0
 
 * Fixed: Rivet doesn't use the CommandTimeout property in rivet.json configuration file.

diff --git a/Rivet/Functions/Checkpoint-Migration.ps1 b/Rivet/Functions/Checkpoint-Migration.ps1
@@ -46,34 +46,13 @@ function Checkpoint-Migration
             return
         }
 
-        $query = @"
-        SELECT CONCAT( FORMAT(ID, '00000000000000'), '_', Name) as MigrationFileName
-        FROM rivet.Migrations
-        WHERE ID > $($script:firstMigrationId)
-"@
-
-        try
-        {
-            Connect-Database -SqlServerName $settings.SqlServerName `
-                            -Database $databaseItem.Name `
-                            -ConnectionTimeout $settings.ConnectionTimeout
-
-            $pushedMigrations = Invoke-Query -Query $query
-        }
-        finally
-        {
-            Disconnect-Database
-        }
-
         Write-Debug "Checkpoint-Migration: Exporting migration on database $($databaseItem.Name)"
-        $migration = Export-Migration -SqlServerName $settings.SqlServerName -Database $databaseItem.Name -ConfigFilePath $ConfigFilePath
+        $migration = Export-Migration -SqlServerName $settings.SqlServerName `
+                                      -Database $databaseItem.Name `
+                                      -ConfigFilePath $ConfigFilePath `
+                                      -Checkpoint
+
         $migration = $migration -join [Environment]::NewLine
         Set-Content -Path $OutputPath -Value $migration
-
-        foreach( $migration in $pushedMigrations )
-        {
-            $migrationFilePath = Join-Path -Path $databaseItem.MigrationsRoot -ChildPath "$($migration.MigrationFileName).ps1"
-            Remove-Item -Path $migrationFilePath
-        }
     }
 }
diff --git a/Rivet/Functions/Export-Migration.ps1 b/Rivet/Functions/Export-Migration.ps1
@@ -41,7 +41,10 @@ function Export-Migration
         # The path to the Rivet configuration file to load. Defaults to `rivet.json` in the current directory.
         [String] $ConfigFilePath,
 
-        [Switch] $NoProgress
+        [Switch] $NoProgress,
+
+        # Checkpoints the current state of the database so that it can be re-created.
+        [Switch] $Checkpoint
     )
 
     Set-StrictMode -Version 'Latest'
@@ -1619,6 +1622,30 @@ where
         $exportedXmlSchemas[$ID] = $true
     }
 
+    $rivetMigrationsTableQuery = "
+    SELECT *
+    FROM rivet.Migrations
+    WHERE ID > $($script:firstMigrationId)"
+
+    function Export-RivetMigrationsTable
+    {
+        [CmdletBinding()]
+        param()
+
+        foreach( $row in $rivetMigrationsTableData )
+        {
+            @"
+    Add-Row -SchemaName 'rivet' -TableName 'Migrations' -Column @{
+        ID = '$($row.Id)';
+        Name = '$($row.Name)';
+        Who = '$($row.Who)';
+        ComputerName = '$($row.ComputerName)';
+        AtUtc = '$($row.AtUtc.ToString("MM/dd/yyyy HH:mm:ss.fffffff"))';
+    }
+"@
+        }
+    }
+
     function Push-PopOperation
     {
         param(
@@ -1949,6 +1976,11 @@ where
             Export-DataType
             Export-Object
             Export-Index
+            if( $Checkpoint )
+            {
+                $rivetMigrationsTableData = Invoke-Query -Query $rivetMigrationsTableQuery
+                Export-RivetMigrationsTable
+            }
         '}'
         ''
         'function Pop-Migration'

diff --git a/Rivet/Functions/Invoke-Rivet.ps1 b/Rivet/Functions/Invoke-Rivet.ps1
@@ -63,6 +63,7 @@ function Invoke-Rivet
         [Parameter(ParameterSetName='Redo')]
         [Parameter(ParameterSetName='DropDatabase')]
         [Parameter(ParameterSetName='Checkpoint')]
+        [Parameter(ParameterSetName='InitializeSchema')]
         [string[]]
         # The database(s) to migrate. Optional.  Will operate on all databases otherwise.
         $Database,
@@ -76,6 +77,7 @@ function Invoke-Rivet
         [Parameter(ParameterSetName='Redo')]
         [Parameter(ParameterSetName='DropDatabase')]
         [Parameter(ParameterSetName='Checkpoint')]
+        [Parameter(ParameterSetName='InitializeSchema')]
         [string]
         # The environment you're working in.  Controls which settings Rivet loads from the `rivet.json` configuration file.
         $Environment,
@@ -89,6 +91,7 @@ function Invoke-Rivet
         [Parameter(ParameterSetName='Redo')]
         [Parameter(ParameterSetName='DropDatabase')]
         [Parameter(ParameterSetName='Checkpoint')]
+        [Parameter(ParameterSetName='InitializeSchema')]
         [string]
         # The path to the Rivet configuration file.  Default behavior is to look in the current directory for a `rivet.json` file.  See `about_Rivet_Configuration` for more information.
         $ConfigFilePath,
@@ -101,7 +104,12 @@ function Invoke-Rivet
         [Parameter(ParameterSetName='Checkpoint')]
         [Switch]
         # Checkpoints the current state of the database so that it can be re-created.
-        $Checkpoint
+        $Checkpoint,
+
+        [Parameter(ParameterSetName='InitializeSchema')]
+        [Switch]
+        # Initializes the database, including baseline schema. Use the -Checkpoint switch to create a database baseline.
+        $InitializeSchema
     )
 
     Set-StrictMode -Version 'Latest'
@@ -193,6 +201,10 @@ Found no databases to migrate. This can be a few things:
             try
             {
                 Initialize-Database -Configuration $settings
+                if( $InitializeSchema )
+                {
+                    continue
+                }
 
                 $updateParams = @{
                                     Path = $dbMigrationsPath;

diff --git a/Rivet/Rivet.psd1 b/Rivet/Rivet.psd1
@@ -11,7 +11,7 @@
     RootModule = 'Rivet.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.18.0'
+    ModuleVersion = '0.19.0'
 
     # ID used to uniquely identify this module
     GUID = '8af34b47-259b-4630-a945-75d38c33b94d'

diff --git a/Rivet/rivet.ps1 b/Rivet/rivet.ps1
@@ -130,6 +130,7 @@ param(
     [Parameter(ParameterSetName='Redo')]
     [Parameter(ParameterSetName='DropDatabase')]
     [Parameter(ParameterSetName='Checkpoint')]
+    [Parameter(ParameterSetName='InitializeSchema')]
     [string[]]
     # The database(s) to migrate. Optional.  Will operate on all databases otherwise.
     $Database,
@@ -143,6 +144,7 @@ param(
     [Parameter(ParameterSetName='Redo')]
     [Parameter(ParameterSetName='DropDatabase')]
     [Parameter(ParameterSetName='Checkpoint')]
+    [Parameter(ParameterSetName='InitializeSchema')]
     [string]
     # The environment you're working in.  Controls which settings Rivet loads from the `rivet.json` configuration file.
     $Environment,
@@ -156,6 +158,7 @@ param(
     [Parameter(ParameterSetName='Redo')]
     [Parameter(ParameterSetName='DropDatabase')]
     [Parameter(ParameterSetName='Checkpoint')]
+    [Parameter(ParameterSetName='InitializeSchema')]
     [string]
     # The path to the Rivet configuration file.  Default behavior is to look in the current directory for a `rivet.json` file.  See `about_Rivet_Configuration` for more information.
     $ConfigFilePath,
@@ -168,7 +171,12 @@ param(
     [Parameter(ParameterSetName='Checkpoint')]
     [Switch]
     # Checkpoints the current state of the database so that it can be re-created.
-    $Checkpoint
+    $Checkpoint,
+
+    [Parameter(ParameterSetName='InitializeSchema')]
+    [Switch]
+    # Initializes the database, including baseline schema. Use the -Checkpoint switch to create a database baseline.
+    $InitializeSchema
 )
 
 Set-StrictMode -Version Latest