functions/Remove-SqlDatabaseSafely.ps1
|
Function Remove-SqlDatabaseSafely { <# .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 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 By default the initial DBCC CHECKDB is performed By default the jobs and databases are created on the same server. Use -DestinationServer to use a seperate server It will start the SQL Agent Service on the Destination Server if it is not running .PARAMETER SqlServer The SQL Server instance holding the databases to be removed.You must have sysadmin access and server version must be SQL Server version 2000 or higher. .PARAMETER SqlCredential Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. $scred = Get-Credential, then pass $scred object to the -SqlCredential parameter. Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials. To connect as a different Windows user, run PowerShell as that user. .PARAMETER DestinationServer If specified this is the server that the Agent Jobs will be created on. By default this is the same server as the SQLServer.You must have sysadmin access and server version must be SQL Server version 2000 or higher. .PARAMETER Databases The database name to remove or an array of database names eg $Databases = 'DB1','DB2','DB3' .PARAMETER NoDBCCCheck If this switch is used the initial DBCC CHECK DB will be skipped. This will make the process quicker but will also create an agent job to restore 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 Final (Golden) Backup Folder for storing the backups. Be Careful if you are using a source and destination server that you use the full UNC path eg \\SERVER1\BACKUPSHARE\ .PARAMETER JobOwner The account that will own the Agent Jobs - Defaults to sa .PARAMETER UseDefaultFilePaths Use the instance default file paths for the mdf and ldf files to restore the database if not set will use the original file paths .PARAMETER DBCCErrorFolder FolderPath for DBCC Error Output - defaults to C:\temp .PARAMETER AllDatabases Runs the script for every user databases on a server - Useful when decomissioning a server - That would need a DestinationServer set .PARAMETER Force This switch will continue to perform rest of the actions and will create an Agent Job with DBCCERROR in the name and a Backup file with DBCC in the name .NOTES Original Author: Rob Sewell @SQLDBAWithBeard, sqldbawithabeard.com With huge thanks to Grant Fritchey and his verify your backups video Take a look its only 3 minutes long http://sqlps.io/backuprant dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com) Copyright (C) 2016 Chrissy LeMaire This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. .LINK https://dbatools.io/Remove-SqlDatabaseSafely .EXAMPLE Remove-SqlDatabaseSafely -SqlServer 'Fade2Black' -Databases RideTheLightning -BackupFolder 'C:\MSSQL\Backup\Rationalised - DO NOT DELETE' For the database RideTheLightning on the server Fade2Black Will perform a DBCC CHECKDB and if there are no errors backup the database to the folder C:\MSSQL\Backup\Rationalised - DO NOT DELETE. It will then create an Agent Job to restore the database from that backup. It will drop the database, run the agent job to restore it, perform a DBCC ChECK DB and then drop the database. Any DBCC errors will be written to your documents folder .EXAMPLE $Databases = 'DemoNCIndex','RemoveTestDatabase' Remove-SqlDatabaseSafely -SqlServer 'Fade2Black' -Databases $Databases -BackupFolder 'C:\MSSQL\Backup\Rationalised - DO NOT DELETE' For the databases 'DemoNCIndex','RemoveTestDatabase' on the server Fade2Black Will perform a DBCC CHECKDB and if there are no errors backup the database to the folder C:\MSSQL\Backup\Rationalised - DO NOT DELETE. It will then create an Agent Job for each database to restore the database from that backup. It will drop the database, run the agent job, perform a DBCC ChECK DB and then drop the database Any DBCC errors will be written to your documents folder .EXAMPLE Remove-SqlDatabaseSafely -SqlServer 'Fade2Black' -DestinationServer JusticeForAll -Databases RideTheLightning -BackupFolder '\\BACKUPSERVER\BACKUPSHARE\MSSQL\Rationalised - DO NOT DELETE' For the database RideTheLightning on the server Fade2Black Will perform a DBCC CHECKDB and if there are no errors backup the database to the folder \\BACKUPSERVER\BACKUPSHARE\MSSQL\Rationalised - DO NOT DELETE It will then create an Agent Job on the server JusticeForAll to restore the database from that backup. It will drop the database on Fade2Black, run the agent job to restore it on JusticeForAll, perform a DBCC ChECK DB and then drop the database Any DBCC errors will be written to your documents folder .EXAMPLE Remove-SqlDatabaseSafely -SqlServer IronMaiden -Databases $Databases -DestinationServer TheWildHearts -DBCCErrorFolder C:\DBCCErrors -BackupFolder z:\Backups -NoDBCCCheck -UseDefaultFilePaths -JobOwner 'THEBEARD\Rob' For the databases $Databases on the server IronMaiden Will NOT perform a DBCC CHECKDB It will backup the databases to the folder Z:\Backups It will then create an Agent Job on the server with a Job Owner of THEBEARD\Rob TheWildHearts to restore the database from that backup using the instance default filepaths. It will drop the database on IronMaiden, run the agent job to restore it on TheWildHearts using the default file paths for the instance, perform a DBCC ChECK DB and then drop the database Any DBCC errors will be written to your documents folder .EXAMPLE Remove-SqlDatabaseSafely -SqlServer IronMaiden -Databases $Databases -DestinationServer TheWildHearts -DBCCErrorFolder C:\DBCCErrors -BackupFolder z:\Backups -UseDefaultFilePaths -ContinueAfterDbccError For the databases $Databases on the server IronMaiden will backup the databases to the folder Z:\Backups It will then create an Agent Job TheWildHearts to restore the database from that backup using the instance default filepaths. It will drop the database on IronMaiden, run the agent job to restore it on TheWildHearts using the default file paths for the instance, perform a DBCC ChECK DB and then drop the database If there is a DBCC Error it 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 = $true, DefaultParameterSetName = "Default")] Param ( [parameter(Mandatory = $true, ValueFromPipeline = $true)] [Alias("ServerInstance", "SqlInstance")] [object]$SqlServer, [parameter(Mandatory = $false)] [object]$SqlCredential, [parameter(Mandatory = $false)] [object]$Destination = $SqlServer, [parameter(Mandatory = $false)] [switch]$NoCheck, [parameter(Mandatory = $true)] [string]$BackupFolder, [parameter(Mandatory = $false)] [string]$CategoryName = 'Rationalisation', [parameter(Mandatory = $false)] [string]$JobOwner, [parameter(Mandatory = $false)] [string]$DbccErrorFolder = [Environment]::GetFolderPath("mydocuments"), [parameter(Mandatory = $false)] [switch]$AllDatabases, [ValidateSet("Default", "On", "Of")] [string]$backupCompression = 'Default', #[Alias("UseDefaultFilePaths")] [switch]$ReuseSourceFolderStructure, [switch]$Force ) DynamicParam { if ($sqlserver) { return Get-ParamSqlDatabases -SqlServer $sqlserver -SqlCredential $SqlCredential } } BEGIN { $databases = $psboundparameters.Databases $sourceserver = Connect-SqlServer -SqlServer $SqlServer -SqlCredential $sqlCredential -ParameterConnection if ($SqlServer -ne $destination) { $destserver = Connect-SqlServer -SqlServer $destination -SqlCredential $sqlCredential $sourcenb = $sourceserver.ComputerNamePhysicalNetBIOS $destnb = $sourceserver.ComputerNamePhysicalNetBIOS if ($BackupFolder.StartsWith("\\") -eq $false -and $sourcenb -ne $destnb) { throw "Backup folder must be a network share if the source and destination servers are not the same." } } else { $destserver = $sourceserver } $source = $sourceserver.DomainInstanceName $destination = $destserver.DomainInstanceName if ($jobowner.Length -eq 0) { $jobowner = Get-SqlSaLogin $destserver } if ($alldatabases -or $databases.count -eq 0) { $databases = ($sourceserver.databases | Where-Object{ $_.IsSystemObject -eq $false }).Name } if (!(Test-SqlPath -SqlServer $destserver -Path $backupFolder)) { $serviceaccount = $destserver.ServiceAccount throw "Can't access $backupFolder Please check if $serviceaccount has permissions" } $jobname = "Rationalised Final Database Restore for $dbname" $jobStepName = "Restore the $dbname database from Final Backup" if (!($destserver.Logins | Where-Object{ $_.Name -eq $jobowner })) { throw "$destination does not contain the login $jobowner - Please fix and try again - Aborting" } function Start-SqlAgent { if ($destserver.InstanceName -eq $null) { $serviceName = 'SqlServerAgent' } else { $instance = $destserver.InstanceName $serviceName = "SQLAgent`$$instance" $SqlServiceName = "MSSQL`$$instance" } if ($Pscmdlet.ShouldProcess($destination, "Starting Sql Agent")) { try { $ipaddr = Resolve-SqlIpAddress $destination $agentservice = Get-Service -ComputerName $ipaddr -Name $serviceName if ($agentservice.Status -ne 'Running') { $agentservice.Start() $timeout = new-timespan -seconds 60 $sw = [diagnostics.stopwatch]::StartNew() $agentstatus = (Get-Service -ComputerName $ipaddr -Name $serviceName).Status while ($dbStatus -ne 'Running' -and $sw.elapsed -lt $timeout) { $dbStatus = (Get-Service -ComputerName $ipaddr -Name $serviceName).Status } } } catch { Write-Exception $_ } if ($agentservice.Status -ne 'Running') { throw "Cannot start Agent Service on $destination - Aborting" } } } Function Start-DbccCheck { param ( [object]$server, [string]$dbname ) $servername = $server.name $db = $server.databases[$dbname] if ($Pscmdlet.ShouldProcess($sourceserver, "Running dbcc check on $dbname on $servername")) { try { $null = $db.CheckTables('None') Write-Output "Dbcc CHECKDB finished successfully for $dbname on $servername" } catch { Write-Warning "DBCC CHECKDB failed" Write-Exception $_ if ($force) { return $true } else { return $false } } } } Function New-SqlAgentJobCategory { param ([string]$categoryname, [object]$jobServer) if (!$jobServer.JobCategories[$categoryname]) { if ($Pscmdlet.ShouldProcess($sourceserver, "Running dbcc check on $dbname on $sourceserver")) { try { Write-Output "Creating Agent Job Category $categoryname" $category = New-Object Microsoft.SqlServer.Management.Smo.Agent.JobCategory $category.Parent = $jobServer $category.Name = $categoryname $category.Create() Write-Output "Created Agent Job Category $categoryname" } catch { Write-Exception $_ throw "FAILED : To Create Agent Job Category $categoryname - Aborting" } } } } Function Restore-Database { <# .SYNOPSIS Internal function. Restores .bak file to Sql database. Creates db if it doesn't exist. $filestructure is a custom object that contains logical and physical file locations. ALTERED To Add TSql switch and remove norecovery switch default #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [Alias('ServerInstance', 'SqlInstance')] [object]$server, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string]$dbname, [Parameter(Mandatory = $true)] [string]$backupfile, [string]$filetype = 'Database', [Parameter(Mandatory = $true)] [object]$filestructure, [switch]$norecovery, [System.Management.Automation.PSCredential]$sqlCredential, [switch]$TSql = $false ) $server = Connect-SqlServer -SqlServer $server -SqlCredential $sqlCredential $servername = $server.name $server.ConnectionContext.StatementTimeout = 0 $restore = New-Object 'Microsoft.SqlServer.Management.Smo.Restore' $restore.ReplaceDatabase = $true foreach ($file in $filestructure.values) { $movefile = New-Object 'Microsoft.SqlServer.Management.Smo.RelocateFile' $movefile.LogicalFileName = $file.logical $movefile.PhysicalFileName = $file.physical $null = $restore.RelocateFiles.Add($movefile) } try { if ($TSql) { $restore.PercentCompleteNotification = 1 $restore.add_Complete($complete) $restore.ReplaceDatabase = $true $restore.Database = $dbname $restore.Action = $filetype $restore.NoRecovery = $norecovery $device = New-Object -TypeName Microsoft.SqlServer.Management.Smo.BackupDeviceItem $device.name = $backupfile $device.devicetype = 'File' $restore.Devices.Add($device) $restorescript = $restore.script($server) return $restorescript } else { $percent = [Microsoft.SqlServer.Management.Smo.PercentCompleteEventHandler] { Write-Progress -id 1 -activity "Restoring $dbname to $servername" -percentcomplete $_.Percent -status ([System.String]::Format("Progress: {0} %", $_.Percent)) } $restore.add_PercentComplete($percent) $restore.PercentCompleteNotification = 1 $restore.add_Complete($complete) $restore.ReplaceDatabase = $true $restore.Database = $dbname $restore.Action = $filetype $restore.NoRecovery = $norecovery $device = New-Object -TypeName Microsoft.SqlServer.Management.Smo.BackupDeviceItem $device.name = $backupfile $device.devicetype = 'File' $restore.Devices.Add($device) Write-Progress -id 1 -activity "Restoring $dbname to $servername" -percentcomplete 0 -status ([System.String]::Format("Progress: {0} %", 0)) $restore.sqlrestore($server) Write-Progress -id 1 -activity "Restoring $dbname to $servername" -status 'Complete' -Completed return $true } } catch { Write-Error "Restore failed: $($_.Exception)" return $false } } } PROCESS { $start = Get-Date Write-Output "Starting Rationalisation Script at $start" foreach ($dbname in $databases) { $db = $sourceserver.databases[$dbname] # The db check is needed when the number of databases exceeds 255, then it's no longer autopopulated if (!$db) { Write-Warning "$dbname does not exist on $source. Aborting routine for this database" continue } $jobname = "Rationalised Database Restore Script for $dbname" $jobStepName = "Restore the $dbname database from Final Backup" $jobServer = $destserver.JobServer if ($jobServer.Jobs[$jobname].count -gt 0) { if ($force -eq $false) { Write-Warning "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 $source")) { Write-Output "Dropping $jobname on $source" $jobServer.Jobs[$jobname].Drop() $jobServer.Jobs.Refresh() } } } Write-Output "Starting Rationalisation of $dbname" ## if we want to Dbcc before to abort if we have a corrupt database to start with if ($NoCheck -eq $false) { if ($Pscmdlet.ShouldProcess($dbname, "Running dbcc check on $dbname on $source")) { Write-Output "Starting Dbcc CHECKDB for $dbname on $source" $dbccgood = Start-DbccCheck -Server $sourceserver -DBName $dbname if ($dbccgood -eq $false) { if ($force -eq $false) { Write-Output "DBCC failed for $dbname (you should check that). Aborting routine for this database" continue } else { Write-Output "DBCC failed, but Force specified. Continuing." } } } } if ($Pscmdlet.ShouldProcess($source, "Backing up $dbname")) { Write-Output "Starting Backup for $dbname on $source" ## Take a Backup try { $timenow = [DateTime]::Now.ToString('yyyyMMdd_HHmmss') $backup = New-Object -TypeName Microsoft.SqlServer.Management.Smo.Backup $backup.Action = [Microsoft.SqlServer.Management.SMO.BackupActionType]::Database $backup.BackupSetDescription = "Final Full Backup of $dbname Prior to Dropping" $backup.Database = $dbname $backup.Checksum = $True if ($sourceserver.versionMajor -gt 9) { $backup.CompressionOption = $backupCompression } if ($force -and $dbccgood -eq $false) { $filename = "$backupFolder\$($dbname)_DBCCERROR_$timenow.bak" } else { $filename = "$backupFolder\$($dbname)_Final_Before_Drop_$timenow.bak" } $devicetype = [Microsoft.SqlServer.Management.Smo.DeviceType]::File $backupDevice = New-Object -TypeName Microsoft.SqlServer.Management.Smo.BackupDeviceItem($filename, $devicetype) $backup.Devices.Add($backupDevice) #Progress $percent = [Microsoft.SqlServer.Management.Smo.PercentCompleteEventHandler] { Write-Progress -id 1 -activity "Backing up database $dbname on $source to $filename" -percentcomplete $_.Percent -status ([System.String]::Format("Progress: {0} %", $_.Percent)) } $backup.add_PercentComplete($percent) $backup.add_Complete($complete) Write-Progress -id 1 -activity "Backing up database $dbname on $source to $filename" -percentcomplete 0 -status ([System.String]::Format("Progress: {0} %", 0)) $backup.SqlBackup($sourceserver) $null = $backup.Devices.Remove($backupDevice) Write-Progress -id 1 -activity "Backing up database $dbname on $source to $filename" -status "Complete" -Completed Write-Output "Backup Completed for $dbname on $source " Write-Output "Running Restore Verify only on Backup of $dbname on $source" try { $restoreverify = New-Object 'Microsoft.SqlServer.Management.Smo.Restore' $restoreverify.Database = $dbname $restoreverify.Devices.AddDevice($filename, $devicetype) $result = $restoreverify.SqlVerify($sourceserver) if ($result -eq $false) { Write-Warning "FAILED : Restore Verify Only failed for $filename on $server - aborting routine for this database" continue } Write-Output "Restore Verify Only for $filename Succeeded " } catch { Write-Warning "FAILED : Restore Verify Only failed for $filename on $server - aborting routine for this database" Write-Exception $_ continue } } catch { Write-Exception $_ Write-Warning "FAILED : To backup database $dbname on $server - aborting routine for this database" continue } } if ($Pscmdlet.ShouldProcess($destination, "Creating Automated Restore Job from Golden Backup for $dbname on $destination")) { Write-Output "Creating Automated Restore Job from Golden Backup for $dbname on $destination " try { if ($force -eq $true -and $dbccgood -eq $false) { $jobName = $jobname -replace "Rationalised", "DBCC ERROR" } ## Create an agent job to restore the database $job = New-Object Microsoft.SqlServer.Management.Smo.Agent.Job $jobServer, $jobname $job.Name = $jobname $job.OwnerLoginName = $jobowner $job.Description = "This job will restore the $dbname database using the final backup located at $filename" ## Create a Job Category if (!$jobServer.JobCategories[$categoryname]) { New-SqlAgentJobCategory -JobServer $jobServer -categoryname $categoryname } $job.Category = $categoryname try { if ($Pscmdlet.ShouldProcess($destination, "Creating Agent Job on $destination")) { Write-Output "Created Agent Job $jobname on $destination " $job.Create() } } catch { Write-Warning "FAILED : To Create Agent Job $jobname on $destination - aborting routine for this database" Write-Exception $_ continue } ## Create Job Step ## Aarons 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 { $restore = New-Object Microsoft.SqlServer.Management.Smo.Restore $device = New-Object -TypeName Microsoft.SqlServer.Management.Smo.BackupDeviceItem $filename, 'FILE' $restore.Devices.Add($device) try { $filelist = $restore.ReadFileList($destserver) } catch { throw 'File list could not be determined. This is likely due to connectivity issues or tiemouts with the Sql Server, the database version is incorrect, or the Sql Server service account does not have access to the file share. Script terminating.' } $filestructure = Get-OfflineSqlFileStructure $destserver $dbname $filelist $ReuseSourceFolderStructure #if ($filestructure -eq $false) #{ # Write-Warning "$dbname contains FILESTREAM and filestreams are not supported by destination server. Skipping." # continue #} $jobStepCommmand = Restore-Database $destserver $dbname $filename "Database" $filestructure -TSql -ErrorAction Stop $jobStep = new-object Microsoft.SqlServer.Management.Smo.Agent.JobStep $job, $jobStepName $jobStep.SubSystem = 'TransactSql' # 'PowerShell' $jobStep.DatabaseName = 'master' $jobStep.Command = $jobStepCommmand $jobStep.OnSuccessAction = 'QuitWithSuccess' $jobStep.OnFailAction = 'QuitWithFailure' if ($Pscmdlet.ShouldProcess($destination, "Creating Agent JobStep on $destination")) { $null = $jobStep.Create() } $jobStartStepid = $jobStep.ID Write-Output "Created Agent JobStep $jobStepName on $destination " } catch { Write-Warning "FAILED : To Create Agent JobStep $jobStepName on $destination - Aborting" Write-Exception $_ continue } if ($Pscmdlet.ShouldProcess($destination, "Applying Agent Job $jobname to $destination")) { $job.ApplyToTargetServer($destination) $job.StartStepID = $jobStartStepid $job.Alter() } } catch { Write-Warning "FAILED : To Create Agent Job $jobname on $destination - aborting routine for $dbname" Write-Exception $_ continue } } if ($Pscmdlet.ShouldProcess($destination, "Dropping Database $dbname on $sourceserver")) { ## Drop the database try { # Remove-SqlDatabase is a function in SharedFunctions.ps1 that tries 3 different ways to drop a database Remove-SqlDatabase -SqlServer $sourceserver -DbName $dbname Write-Output "Dropped $dbname Database on $source prior to running the Agent Job" } catch { Write-Warning "FAILED : To Drop database $dbname on $server - aborting routine for $dbname" Write-Exception $_ continue } } if ($Pscmdlet.ShouldProcess($destination, "Running Agent Job on $destination to restore $dbname")) { ## Run the restore job to restore it Write-Output "Starting $jobname on $destination " try { $job = $destserver.JobServer.Jobs[$jobname] $job.Start() $status = $job.CurrentRunStatus while ($status -ne 'Idle') { Write-Output "Restore Job for $dbname on $destination is $status..." $job.Refresh() $status = $job.CurrentRunStatus Start-Sleep -Seconds 5 } Write-Output "Restore Job $jobname has completed on $destination " Write-Output "Sleeping for a few seconds to ensure the next step (DBCC) succeeds" Start-Sleep -Seconds 5 ## This is required to ensure the next DBCC Check succeeds } catch { Write-Warning "FAILED : Restore Job $jobname failed on $destination - aborting routine for $dbname" Write-Exception $_ continue } if ($job.LastRunOutcome -ne 'Succeeded') { # LOL, love the plug. Write-Warning "FAILED : Restore Job $jobname failed on $destination - aborting routine for $dbname" Write-Warning "Check the Agent Job History on $destination - if you have SSMS2016 July release or later" Write-Warning "Get-SqlAgentJobHistory -JobName $jobname -ServerInstance $destination -OutcomesType Failed " continue } } ## Run a Dbcc No choice here if ($Pscmdlet.ShouldProcess($dbname, "Running Dbcc CHECKDB on $dbname on $destination")) { Write-Output "Starting Dbcc CHECKDB for $dbname on $destination" $null = Start-DbccCheck -Server $destserver -DbName $dbname } if ($Pscmdlet.ShouldProcess($dbname, "Dropping Database $dbname on $destination")) { ## Drop the database try { $null = Remove-SqlDatabase -SqlServer $sourceserver -DbName $dbname Write-Output "Dropped $dbname Database on $destination" } catch { Write-Warning "FAILED : To Drop database $dbname on $destination - Aborting" Write-Exception $_ continue } } Write-Output "Rationalisation Finished for $dbname" } } END { $sourceserver.ConnectionContext.Disconnect() $destserver.ConnectionContext.Disconnect() if ($Pscmdlet.ShouldProcess("console", "Showing final message")) { $End = Get-Date Write-Output "Finished at $End" $Duration = $End - $start Write-Output "Script Duration: $Duration" } } } |