functions/Remove-DbaDatabaseSnapshot.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
#ValidationTags#FlowControl#
function Remove-DbaDatabaseSnapshot {
<#
.SYNOPSIS
Removes database snapshots
 
.DESCRIPTION
Removes (drops) database snapshots from the server
 
.PARAMETER SqlInstance
The SQL Server that you're connecting to
 
.PARAMETER SqlCredential
Credential object used to connect to the SQL Server as a different user
 
.PARAMETER Database
Removes snapshots for only this specific base db
 
.PARAMETER ExcludeDatabase
Removes snapshots excluding this specific base dbs
 
.PARAMETER Snapshot
Restores databases from snapshot with this name only
 
.PARAMETER AllSnapshots
Specifies that you want to remove all snapshots from the server
 
.PARAMETER Force
Will forcibly kill all running queries that prevent the drop process.
 
.PARAMETER WhatIf
Shows what would happen if the command were to run
 
.PARAMETER Confirm
Prompts for confirmation of every step.
 
.PARAMETER PipelineSnapshot
Internal parameter
 
.PARAMETER Silent
Use this switch to disable any kind of verbose messages
 
.NOTES
Tags: Snapshot, Database
Author: niphlod
 
Website: https://dbatools.io
Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
.LINK
 https://dbatools.io/Remove-DbaDatabaseSnapshot
 
.EXAMPLE
Remove-DbaDatabaseSnapshot -SqlInstance sqlserver2014a
 
Removes all database snapshots from sqlserver2014a
 
.EXAMPLE
Remove-DbaDatabaseSnapshot -SqlInstance sqlserver2014a -Snapshot HR_snap_20161201, HR_snap_20161101
 
Removes database snapshots named HR_snap_20161201 and HR_snap_20161101
 
.EXAMPLE
Remove-DbaDatabaseSnapshot -SqlInstance sqlserver2014a -Database HR, Accounting
 
Removes all database snapshots having HR and Accounting as base dbs
 
.EXAMPLE
Remove-DbaDatabaseSnapshot -SqlInstance sqlserver2014a -Snapshot HR_snapshot, Accounting_snapshot
 
Removes HR_snapshot and Accounting_snapshot
 
.EXAMPLE
Get-DbaDatabaseSnapshot -SqlInstance sql2016 | Where SnapshotOf -like '*dumpsterfire*' | Remove-DbaDatabaseSnapshot
 
Removes all snapshots associated with databases that have dumpsterfire in the name
 
#>

[CmdletBinding(SupportsShouldProcess = $true)]
Param (
[parameter(Mandatory = $false, ValueFromPipeline = $true)]
[Alias("ServerInstance", "SqlServer")]
[DbaInstanceParameter[]]$SqlInstance,
[Alias("Credential")]
[PSCredential]
$SqlCredential,
[Alias("Databases")]
[object[]]$Database,
[object[]]$ExcludeDatabase,
[object[]]$Snapshot,
[parameter(ValueFromPipeline = $true)]
[object]$PipelineSnapshot,
[switch]$AllSnapshots,
[switch]$Force,
[switch]$Silent
)

process {
if (!$Snapshot -and !$Database -and !$AllSnapshots -and $null -eq $PipelineSnapshot -and !$ExcludeDatabase) {
Stop-Function -Message "You must specify -Snapshot, -Database, -Exclude or -AllSnapshots"
return
}
# handle the database object passed by the pipeline
# do we need a specialized type back ?
if ($null -ne $PipelineSnapshot -and $PipelineSnapshot.getType().Name -eq 'pscustomobject') {
if ($Pscmdlet.ShouldProcess($PipelineSnapshot.SnapshotDb.Parent.DomainInstanceName, "Remove db snapshot $($PipelineSnapshot.SnapshotDb.Name)")) {
try {
$server = Connect-SqlInstance -SqlInstance $PipelineSnapshot.SnapshotDb.Parent.DomainInstanceName -SqlCredential $Credential
} catch {
Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
}
try {
if ($Force) {
$server.KillAllProcesses($PipelineSnapshot.SnapshotDb.Name)
}
$null = $server.Query("drop database [$($PipelineSnapshot.SnapshotDb.Name)]")
$status = "Dropped"
} catch {
Write-Message -Level Warning -Message $_
$status = "Drop failed"
}

[PSCustomObject]@{
ComputerName = $PipelineSnapshot.SnapshotDb.Parent.NetName
InstanceName = $PipelineSnapshot.SnapshotDb.Parent.ServiceName
SqlInstance = $PipelineSnapshot.SnapshotDb.Parent.DomainInstanceName
Database    = $PipelineSnapshot.Database
SnapshotOf  = $PipelineSnapshot.SnapshotOf
Status      = $status
}
}
return
}

# if piped value either doesn't exist or is not the proper type
foreach ($instance in $SqlInstance) {
Write-Message -Level Verbose -Message "Connecting to $instance"
try {
$server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $Credential
} catch {
Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
}


$dbs = $server.Databases
if ($Database) {
$dbs = $dbs | Where-Object { $Database -contains $_.DatabaseSnapshotBaseName }
}

if ($ExcludeDatabase) {
$dbs = $dbs | Where-Object { $ExcludeDatabase -notcontains $_.DatabaseSnapshotBaseName }
}

if ($Snapshot) {
$dbs = $dbs | Where-Object { $Snapshot -contains $_.Name }
}

if (!$Snapshot -and !$Database) {
$dbs = $dbs | Where-Object IsDatabaseSnapshot -eq $true | Sort-Object DatabaseSnapshotBaseName, Name
}


foreach ($db in $dbs) {
if ($db.IsAccessible -eq $false) {
Write-Message -Level Warning -Message "Database $db is not accessible."
continue
}
if ($Pscmdlet.ShouldProcess($server.name, "Remove db snapshot $db")) {
$basedb = $db.DatabaseSnapshotBaseName
try {
if ($Force) {
# cannot drop the snapshot if someone is using it
$server.KillAllProcesses($db)
}
$null = $server.Query("drop database $db")
$status = "Dropped"
} catch {
Write-Message -Level Warning -Message $_
$status = "Drop failed"
}
[PSCustomObject]@{
ComputerName = $server.NetName
InstanceName = $server.ServiceName
SqlInstance  = $server.DomainInstanceName
Database     = $db
SnapshotOf   = $basedb
Status       = $status
}
}
}
}
}
}