functions/Remove-DbaDatabaseSafely.ps1
|
function Remove-DbaDatabaseSafely { <# .SYNOPSIS Safely removes a SQL Database and creates an Agent Job to restore it. .DESCRIPTION Performs a DBCC CHECKDB on the database, backs up the database with Checksum and verify only to a final (golden) backup location, creates an Agent Job to restore from that backup, drops the database, runs the agent job to restore the database, performs a DBCC CHECKDB and drops the database. With huge thanks to Grant Fritchey and his verify your backups video. Take a look, it's only 3 minutes long. http://sqlps.io/backuprant .PARAMETER SqlInstance The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2000 or higher. .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Destination If specified, Agent jobs will be created on this server. By default, the jobs will be created on the server specified by SqlInstance. You must have sysadmin access and the server must be SQL Server 2000 or higher. The SQL Agent service will be started if it is not already running. .PARAMETER DestinationCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Database Specifies one or more databases to remove. .PARAMETER NoDbccCheckDb If this switch is enabled, the initial DBCC CHECK DB will be skipped. This will make the process quicker but will also allow you to create an Agent job that restores a database backup containing a corrupt database. A second DBCC CHECKDB is performed on the restored database so you will still be notified BUT USE THIS WITH CARE. .PARAMETER BackupFolder Specifies the path to a folder where the final backups of the removed databases will be stored. If you are using separate source and destination servers, you must specify a UNC path such as \\SERVER1\BACKUPSHARE\ .PARAMETER JobOwner Specifies the name of the account which will own the Agent jobs. By default, sa is used. .PARAMETER UseDefaultFilePaths If this switch is enabled, the default file paths for the data and log files on the instance where the database is restored will be used. By default, the original file paths will be used. .PARAMETER CategoryName Specifies the Category Name for the Agent job that is created for restoring the database(s). By default, the name is "Rationalisation". .PARAMETER BackupCompression If this switch is enabled, compression will be used for the backup regardless of the SQL Server instance setting. By default, the SQL Server instance setting for backup compression is used. .PARAMETER AllDatabases If this switch is enabled, all user databases on the server will be removed. This is useful when decommissioning a server. You should use a Destination with this switch. .PARAMETER ReuseSourceFolderStructure If this switch is enabled, the source folder structure will be used when restoring instead of using the destination instance default folder structure. .PARAMETER Force If this switch is enabled, all actions will be performed even if DBCC errors are detected. An Agent job will be created with 'DBCCERROR' in the name and the backup file will have 'DBCC' in its name. .PARAMETER WhatIf If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: Database, Remove Author: Rob Sewell (@SQLDBAWithBeard), sqldbawithabeard.com Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Remove-DbaDatabaseSafely .EXAMPLE PS C:\> Remove-DbaDatabaseSafely -SqlInstance 'Fade2Black' -Database RideTheLightning -BackupFolder 'C:\MSSQL\Backup\Rationalised - DO NOT DELETE' Performs a DBCC CHECKDB on database RideTheLightning on server Fade2Black. If there are no errors, the database is backup to the folder C:\MSSQL\Backup\Rationalised - DO NOT DELETE. Then, an Agent job to restore the database from that backup is created. The database is then dropped, the Agent job to restore it run, a DBCC CHECKDB run against the restored database, and then it is dropped again. Any DBCC errors will be written to your documents folder .EXAMPLE PS C:\> $Database = 'DemoNCIndex','RemoveTestDatabase' PS C:\> Remove-DbaDatabaseSafely -SqlInstance 'Fade2Black' -Database $Database -BackupFolder 'C:\MSSQL\Backup\Rationalised - DO NOT DELETE' Performs a DBCC CHECKDB on two databases, 'DemoNCIndex' and 'RemoveTestDatabase' on server Fade2Black. Then, an Agent job to restore each database from those backups is created. The databases are then dropped, the Agent jobs to restore them run, a DBCC CHECKDB run against the restored databases, and then they are dropped again. Any DBCC errors will be written to your documents folder .EXAMPLE PS C:\> Remove-DbaDatabaseSafely -SqlInstance 'Fade2Black' -Destination JusticeForAll -Database RideTheLightning -BackupFolder '\\BACKUPSERVER\BACKUPSHARE\MSSQL\Rationalised - DO NOT DELETE' Performs a DBCC CHECKDB on database RideTheLightning on server Fade2Black. If there are no errors, the database is backup to the folder \\BACKUPSERVER\BACKUPSHARE\MSSQL\Rationalised - DO NOT DELETE . Then, an Agent job is created on server JusticeForAll to restore the database from that backup is created. The database is then dropped on Fade2Black, the Agent job to restore it on JusticeForAll is run, a DBCC CHECKDB run against the restored database, and then it is dropped from JusticeForAll. Any DBCC errors will be written to your documents folder .EXAMPLE PS C:\> Remove-DbaDatabaseSafely -SqlInstance IronMaiden -Database $Database -Destination TheWildHearts -BackupFolder Z:\Backups -NoDbccCheckDb -JobOwner 'THEBEARD\Rob' For the databases $Database on the server IronMaiden a DBCC CHECKDB will not be performed before backing up the databases to the folder Z:\Backups. Then, an Agent job is created on server TheWildHearts with a Job Owner of THEBEARD\Rob to restore each database from that backup using the instance's default file paths. The database(s) is(are) then dropped on IronMaiden, the Agent job(s) run, a DBCC CHECKDB run on the restored database(s), and then the database(s) is(are) dropped. .EXAMPLE PS C:\> Remove-DbaDatabaseSafely -SqlInstance IronMaiden -Database $Database -Destination TheWildHearts -BackupFolder Z:\Backups The databases $Database on the server IronMaiden will be backed up the to the folder Z:\Backups. Then, an Agent job is created on server TheWildHearts with a Job Owner of THEBEARD\Rob to restore each database from that backup using the instance's default file paths. The database(s) is(are) then dropped on IronMaiden, the Agent job(s) run, a DBCC CHECKDB run on the restored database(s), and then the database(s) is(are) dropped. If there is a DBCC Error, the function will continue to perform rest of the actions and will create an Agent job with 'DBCCERROR' in the name and a Backup file with 'DBCCError' in the name. #> [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "Default", ConfirmImpact = "Medium")] param ( [parameter(Mandatory, ValueFromPipeline)] [DbaInstanceParameter]$SqlInstance, [PSCredential]$SqlCredential, [object[]]$Database, [DbaInstanceParameter]$Destination = $SqlInstance, [PSCredential]$DestinationCredential, [Alias("NoCheck")] [switch]$NoDbccCheckDb, [parameter(Mandatory)] [string]$BackupFolder, [string]$CategoryName = 'Rationalisation', [string]$JobOwner, [switch]$AllDatabases, [ValidateSet("Default", "On", "Off")] [string]$BackupCompression = 'Default', [switch]$ReuseSourceFolderStructure, [switch]$Force, [switch]$EnableException ) begin { if ($Force) {$ConfirmPreference = 'none'} if (!$AllDatabases -and !$Database) { Stop-Function -Message "You must specify at least one database. Use -Database or -AllDatabases." -ErrorRecord $_ return } $sourceserver = Connect-SqlInstance -SqlInstance $SqlInstance -SqlCredential $sqlCredential if (-not $destination) { $destination = $SqlInstance $DestinationCredential = $SqlCredential } if ($SqlInstance -ne $destination) { $destserver = Connect-SqlInstance -SqlInstance $destination -SqlCredential $DestinationCredential $sourcenb = $instance.ComputerName $destnb = $instance.ComputerName if ($BackupFolder.StartsWith("\\") -eq $false -and $sourcenb -ne $destnb) { Stop-Function -Message "Backup folder must be a network share if the source and destination servers are not the same." -ErrorRecord $_ -Target $backupFolder return } } else { $destserver = $sourceserver } $source = $sourceserver.DomainInstanceName $destination = $destserver.DomainInstanceName if (!$jobowner) { $jobowner = Get-SqlSaLogin -SqlInstance $destserver } if ($alldatabases -or !$Database) { $database = ($sourceserver.databases | Where-Object { $_.IsSystemObject -eq $false -and ($_.Status -match 'Offline') -eq $false }).Name } if (!(Test-DbaPath -SqlInstance $destserver -Path $backupFolder)) { $serviceaccount = $destserver.ServiceAccount Stop-Function -Message "Can't access $backupFolder Please check if $serviceaccount has permissions." -ErrorRecord $_ -Target $backupFolder } #TODO: Test $jobname = "Rationalised Final Database Restore for $dbname" $jobStepName = "Restore the $dbname database from Final Backup" if (!($destserver.Logins | Where-Object { $_.Name -eq $jobowner })) { Stop-Function -Message "$destination does not contain the login $jobowner - Please fix and try again - Aborting." -ErrorRecord $_ -Target $jobowner } } process { if (Test-FunctionInterrupt) { return } $start = Get-Date try { $destInstanceName = $destserver.InstanceName if ($destserver.EngineEdition -match "Express") { Write-Message -Level Warning -Message "$destInstanceName is Express Edition which does not support SQL Server Agent." return } if ($destInstanceName -eq '') { $destInstanceName = "MSSQLSERVER" } $agentService = Get-DbaService -ComputerName $destserver.ComputerName -InstanceName $destInstanceName -Type Agent if ($agentService.State -ne 'Running') { Stop-Function -Message "SQL Server Agent is not running. Please start the service." -ErrorAction $agentService.Name } else { Write-Message -Level Verbose -Message "SQL Server Agent $($agentService.Name) is running." } } catch { Stop-Function -Message "Failure getting SQL Agent service" -ErrorRecord $_ return } Write-Message -Level Verbose -Message "Starting Rationalisation Script at $start." foreach ($dbname in $Database) { $db = $sourceserver.databases[$dbname] # The db check is needed when the number of databases exceeds 255, then it's no longer auto-populated if (!$db) { Stop-Function -Message "$dbname does not exist on $source. Aborting routine for this database." -Continue } $lastFullBckDuration = ( Get-DbaDbBackupHistory -SqlInstance $sourceserver -Database $dbname -LastFull).Duration if (-NOT ([string]::IsNullOrEmpty($lastFullBckDuration))) { $lastFullBckDurationSec = $lastFullBckDuration.TotalSeconds $lastFullBckDurationMin = [Math]::Round($lastFullBckDuration.TotalMinutes, 2) Write-Message -Level Verbose -Message "From the backup history the last full backup took $lastFullBckDurationSec seconds ($lastFullBckDurationMin minutes)" if ($lastFullBckDurationSec -gt 600) { Write-Message -Level Verbose -Message "Last full backup took more than 10 minutes. Do you want to continue?" # Set up the parts for the user choice $Title = "Backup duration" $Info = "Last full backup took more than $lastFullBckDurationMin minutes. Do you want to continue?" $Options = [System.Management.Automation.Host.ChoiceDescription[]] @("&Yes", "&No (Skip)") [int]$Defaultchoice = 0 $choice = $host.UI.PromptForChoice($Title, $Info, $Options, $Defaultchoice) # Check the given option if ($choice -eq 1) { Stop-Function -Message "You have chosen skipping the database $dbname because of last known backup time ($lastFullBckDurationMin minutes)." -ErrorRecord $_ -Target $dbname -Continue Continue } } } else { Write-Message -Level Verbose -Message "Couldn't find last full backup time for database $dbname using Get-DbaDbBackupHistory." } $jobname = "Rationalised Database Restore Script for $dbname" $jobStepName = "Restore the $dbname database from Final Backup" $checkJob = Get-DbaAgentJob -SqlInstance $destserver -Job $jobname if ($checkJob.count -gt 0) { if ($Force -eq $false) { Stop-Function -Message "FAILED: The Job $jobname already exists. Have you done this before? Rename the existing job and try again or use -Force to drop and recreate." -Continue } else { if ($Pscmdlet.ShouldProcess($dbname, "Dropping $jobname on $destination")) { Write-Message -Level Verbose -Message "Dropping $jobname on $destination." $checkJob.Drop() } } } Write-Message -Level Verbose -Message "Starting Rationalisation of $dbname." ## if we want to Dbcc before to abort if we have a corrupt database to start with if ($NoDbccCheckDb -eq $false) { if ($Pscmdlet.ShouldProcess($dbname, "Running dbcc check on $dbname on $source")) { Write-Message -Level Verbose -Message "Starting DBCC CHECKDB for $dbname on $source." $dbccgood = Start-DbccCheck -server $sourceserver -dbname $dbname -table if ($dbccgood -ne "Success") { if ($Force -eq $false) { Write-Message -Level Verbose -Message "DBCC failed for $dbname (you should check that). Aborting routine for this database." continue } else { Write-Message -Level Verbose -Message "DBCC failed, but Force specified. Continuing." } } } } if ($Pscmdlet.ShouldProcess($source, "Backing up $dbname")) { Write-Message -Level Verbose -Message "Starting Backup for $dbname on $source." ## Take a Backup try { $timenow = [DateTime]::Now.ToString('yyyyMMdd_HHmmss') if ($Force -and $dbccgood -ne "Success") { $filename = "$backupFolder\$($dbname)_DBCCERROR_$timenow.bak" } else { $filename = "$backupFolder\$($dbname)_Final_Before_Drop_$timenow.bak" } $DefaultCompression = $sourceserver.Configuration.DefaultBackupCompression.ConfigValue $backupWithCompressionParams = @{ SqlInstance = $SqlInstance SqlCredential = $SqlCredential Database = $dbname BackupFileName = $filename CompressBackup = $true Checksum = $true } $backupWithoutCompressionParams = @{ SqlInstance = $SqlInstance SqlCredential = $SqlCredential Database = $dbname BackupFileName = $filename Checksum = $true } if ($BackupCompression -eq "Default") { if ($DefaultCompression -eq 1) { $null = Backup-DbaDatabase @backupWithCompressionParams } else { $null = Backup-DbaDatabase @backupWithoutCompressionParams } } elseif ($BackupCompression -eq "On") { $null = Backup-DbaDatabase @backupWithCompressionParams } else { $null = Backup-DbaDatabase @backupWithoutCompressionParams } } catch { Stop-Function -Message "FAILED : Restore Verify Only failed for $filename on $server - aborting routine for this database. Exception: $_" -Target $filename -ErrorRecord $_ -Continue } } if ($Pscmdlet.ShouldProcess($destination, "Creating Automated Restore Job from Golden Backup for $dbname on $destination")) { Write-Message -Level Verbose -Message "Creating Automated Restore Job from Golden Backup for $dbname on $destination." try { if ($Force -eq $true -and $dbccgood -ne "Success") { $jobName = $jobname -replace "Rationalised", "DBCC ERROR" } ## Create a Job Category if (!(Get-DbaAgentJobCategory -SqlInstance $destination -SqlCredential $DestinationCredential -Category $categoryname)) { New-DbaAgentJobCategory -SqlInstance $destination -SqlCredential $DestinationCredential -Category $categoryname } try { if ($Pscmdlet.ShouldProcess($destination, "Creating Agent Job $jobname on $destination")) { $jobParams = @{ SqlInstance = $destination SqlCredential = $DestinationCredential Job = $jobname Category = $categoryname Description = "This job will restore the $dbname database using the final backup located at $filename." Owner = $jobowner } $job = New-DbaAgentJob @jobParams Write-Message -Level Verbose -Message "Created Agent Job $jobname on $destination." } } catch { Stop-Function -Message "FAILED : To Create Agent Job $jobname on $destination - aborting routine for this database." -Target $categoryname -ErrorRecord $_ -Continue } ## Create Job Step ## Aaron's Suggestion: In the restore script, add a comment block that tells the last known size of each file in the database. ## Suggestion check for disk space before restore ## Create Restore Script try { $jobStepCommand = Restore-DbaDatabase -SqlInstance $destserver -Path $filename -OutputScriptOnly -WithReplace $jobStepParams = @{ SqlInstance = $destination SqlCredential = $DestinationCredential Job = $job StepName = $jobStepName SubSystem = 'TransactSql' Command = $jobStepCommand Database = 'master' OnSuccessAction = 'QuitWithSuccess' OnFailAction = 'QuitWithFailure' StepId = 1 } if ($Pscmdlet.ShouldProcess($destination, "Creating Agent JobStep on $destination")) { $jobStep = New-DbaAgentJobStep @jobStepParams } $jobStartStepid = $jobStep.ID Write-Message -Level Verbose -Message "Created Agent JobStep $jobStepName on $destination." } catch { Stop-Function -Message "FAILED : To Create Agent JobStep $jobStepName on $destination - Aborting." -Target $jobStepName -ErrorRecord $_ -Continue } if ($Pscmdlet.ShouldProcess($destination, "Applying Agent Job $jobname to $destination")) { $job.StartStepID = $jobStartStepid $job.Alter() } } catch { Stop-Function -Message "FAILED : To Create Agent Job $jobname on $destination - aborting routine for $dbname. Exception: $_" -Target $jobname -ErrorRecord $_ -Continue } } if ($Pscmdlet.ShouldProcess($destination, "Dropping Database $dbname on $sourceserver")) { ## Drop the database try { $null = Remove-DbaDatabase -SqlInstance $sourceserver -Database $dbname -Confirm:$false Write-Message -Level Verbose -Message "Dropped $dbname Database on $source prior to running the Agent Job" } catch { Stop-Function -Message "FAILED : To Drop database $dbname on $server - aborting routine for $dbname. Exception: $_" -Continue } } if ($Pscmdlet.ShouldProcess($destination, "Running Agent Job on $destination to restore $dbname")) { ## Run the restore job to restore it Write-Message -Level Verbose -Message "Starting $jobname on $destination." try { $job.Start() $job.Refresh() $status = $job.CurrentRunStatus while ($status -ne 'Idle') { Write-Message -Level Verbose -Message "Restore Job for $dbname on $destination is $status." Start-Sleep -Seconds 15 $job.Refresh() $status = $job.CurrentRunStatus } Write-Message -Level Verbose -Message "Restore Job $jobname has completed on $destination." Write-Message -Level Verbose -Message "Sleeping for a few seconds to ensure the next step (DBCC) succeeds." Start-Sleep -Seconds 10 ## This is required to ensure the next DBCC Check succeeds } catch { Stop-Function -Message "FAILED : Restore Job $jobname failed on $destination - aborting routine for $dbname. Exception: $_" -Continue } if ($job.LastRunOutcome -ne 'Succeeded') { # LOL, love the plug. Write-Message -Level Warning -Message "FAILED : Restore Job $jobname failed on $destination - aborting routine for $dbname." Write-Message -Level Warning -Message "Check the Agent Job History on $destination - if you have SSMS2016 July release or later." Write-Message -Level Warning -Message "Get-DbaAgentJobHistory -SqlInstance $destination -Job '$jobname'." continue } $refreshRetries = 1 $destserver.Databases.Refresh() $restoredDatabase = Get-DbaDatabase -SqlInstance $destserver -Database $dbname while ($null -eq $restoredDatabase -and $refreshRetries -lt 6) { Write-Message -Level verbose -Message "Database $dbname not found! Refreshing collection." #refresh database list, otherwise the next step (DBCC) can fail $restoredDatabase.Parent.Databases.Refresh() Start-Sleep -Seconds 1 $refreshRetries += 1 } } ## Run a Dbcc No choice here if ($Pscmdlet.ShouldProcess($dbname, "Running Dbcc CHECKDB on $dbname on $destination")) { Write-Message -Level Verbose -Message "Starting Dbcc CHECKDB for $dbname on $destination." $dbccgood = Start-DbccCheck -server $sourceserver -dbname $dbname -table if ($dbccgood -ne "Success") { Write-Message -Level Verbose -Message "DBCC CHECKDB finished successfully for $dbname on $servername." } else { Write-Message -Level Verbose -Message "DBCC failed for $dbname (you should check that). Continuing." } } if ($Pscmdlet.ShouldProcess($dbname, "Dropping Database $dbname on $destination")) { ## Drop the database try { $null = Remove-DbaDatabase -SqlInstance $destserver -Database $dbname -Confirm:$false Write-Message -Level Verbose -Message "Dropped $dbname database on $destination." } catch { Stop-Function -Message "FAILED : To Drop database $dbname on $destination - Aborting. Exception: $_" -Target $dbname -ErrorRecord $_ -Continue } } Write-Message -Level Verbose -Message "Rationalisation Finished for $dbname." [PSCustomObject]@{ SqlInstance = $source DatabaseName = $dbname JobName = $jobname TestingInstance = $destination BackupFolder = $backupFolder } } } end { if (Test-FunctionInterrupt) { return } if ($Pscmdlet.ShouldProcess("console", "Showing final message")) { $End = Get-Date Write-Message -Level Verbose -Message "Finished at $End." $Duration = $End - $start Write-Message -Level Verbose -Message "Script Duration: $Duration." } } } |