-
Notifications
You must be signed in to change notification settings - Fork 225
/
MSFT_SqlDatabase.psm1
325 lines (276 loc) · 9.62 KB
/
MSFT_SqlDatabase.psm1
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
$script:resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent
$script:modulesFolderPath = Join-Path -Path $script:resourceModulePath -ChildPath 'Modules'
$script:localizationModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath 'DscResource.LocalizationHelper'
Import-Module -Name (Join-Path -Path $script:localizationModulePath -ChildPath 'DscResource.LocalizationHelper.psm1')
$script:resourceHelperModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath 'DscResource.Common'
Import-Module -Name (Join-Path -Path $script:resourceHelperModulePath -ChildPath 'DscResource.Common.psm1')
<#
.SYNOPSIS
This function gets the sql database.
.PARAMETER Ensure
When set to 'Present', the database will be created.
When set to 'Absent', the database will be dropped.
.PARAMETER Name
The name of database to be created or dropped.
.PARAMETER ServerName
The host name of the SQL Server to be configured.
.PARAMETER InstanceName
The name of the SQL instance to be configured.
.PARAMETER Collation
The name of the SQL collation to use for the new database.
Defaults to server collation.
#>
function Get-TargetResource
{
[CmdletBinding()]
[OutputType([System.Collections.Hashtable])]
param
(
[Parameter()]
[ValidateSet('Present', 'Absent')]
[ValidateNotNullOrEmpty()]
[System.String]
$Ensure = 'Present',
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$Name,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$ServerName,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$InstanceName,
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.String]
$Collation
)
$sqlServerObject = Connect-SQL -ServerName $ServerName -InstanceName $InstanceName
if ($sqlServerObject)
{
$sqlDatabaseCollation = $sqlServerObject.Collation
Write-Verbose -Message 'Getting SQL Databases'
# Check database exists
$sqlDatabaseObject = $sqlServerObject.Databases[$Name]
if ($sqlDatabaseObject)
{
Write-Verbose -Message "SQL Database name $Name is present"
$Ensure = 'Present'
$sqlDatabaseCollation = $sqlDatabaseObject.Collation
}
else
{
Write-Verbose -Message "SQL Database name $Name is absent"
$Ensure = 'Absent'
}
}
$returnValue = @{
Name = $Name
Ensure = $Ensure
ServerName = $ServerName
InstanceName = $InstanceName
Collation = $sqlDatabaseCollation
}
$returnValue
}
<#
.SYNOPSIS
This function create or delete a database in the SQL Server instance provided.
.PARAMETER Ensure
When set to 'Present', the database will be created.
When set to 'Absent', the database will be dropped.
.PARAMETER Name
The name of database to be created or dropped.
.PARAMETER ServerName
The host name of the SQL Server to be configured.
.PARAMETER InstanceName
The name of the SQL instance to be configured.
.PARAMETER Collation
The name of the SQL collation to use for the new database.
Defaults to server collation.
#>
function Set-TargetResource
{
[CmdletBinding()]
param
(
[Parameter()]
[ValidateSet('Present', 'Absent')]
[ValidateNotNullOrEmpty()]
[System.String]
$Ensure = 'Present',
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$Name,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$ServerName,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$InstanceName,
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.String]
$Collation
)
$sqlServerObject = Connect-SQL -ServerName $ServerName -InstanceName $InstanceName
if ($sqlServerObject)
{
if ($Ensure -eq 'Present')
{
if (-not $PSBoundParameters.ContainsKey('Collation'))
{
$Collation = $sqlServerObject.Collation
}
elseif ($Collation -notin $sqlServerObject.EnumCollations().Name)
{
throw New-TerminatingError -ErrorType InvalidCollationError `
-FormatArgs @($ServerName, $InstanceName, $Name, $Collation) `
-ErrorCategory InvalidOperation
}
$sqlDatabaseObject = $sqlServerObject.Databases[$Name]
if ($sqlDatabaseObject)
{
try
{
Write-Verbose -Message "Updating the database $Name with specified settings."
$sqlDatabaseObject.Collation = $Collation
$sqlDatabaseObject.Alter()
New-VerboseMessage -Message "Updated Database $Name."
}
catch
{
throw New-TerminatingError -ErrorType UpdateDatabaseSetError `
-FormatArgs @($ServerName, $InstanceName, $Name) `
-ErrorCategory InvalidOperation `
-InnerException $_.Exception
}
}
else
{
try
{
$sqlDatabaseObjectToCreate = New-Object -TypeName Microsoft.SqlServer.Management.Smo.Database -ArgumentList $sqlServerObject, $Name
if ($sqlDatabaseObjectToCreate)
{
Write-Verbose -Message "Adding to SQL the database $Name."
$sqlDatabaseObjectToCreate.Collation = $Collation
$sqlDatabaseObjectToCreate.Create()
New-VerboseMessage -Message "Created Database $Name."
}
}
catch
{
throw New-TerminatingError -ErrorType CreateDatabaseSetError `
-FormatArgs @($ServerName, $InstanceName, $Name) `
-ErrorCategory InvalidOperation `
-InnerException $_.Exception
}
}
}
else
{
try
{
$sqlDatabaseObjectToDrop = $sqlServerObject.Databases[$Name]
if ($sqlDatabaseObjectToDrop)
{
Write-Verbose -Message "Deleting to SQL the database $Name."
$sqlDatabaseObjectToDrop.Drop()
New-VerboseMessage -Message "Dropped Database $Name."
}
}
catch
{
throw New-TerminatingError -ErrorType DropDatabaseSetError `
-FormatArgs @($ServerName, $InstanceName, $Name) `
-ErrorCategory InvalidOperation `
-InnerException $_.Exception
}
}
}
}
<#
.SYNOPSIS
This function tests if the sql database is already created or dropped.
.PARAMETER Ensure
When set to 'Present', the database will be created.
When set to 'Absent', the database will be dropped.
.PARAMETER Name
The name of database to be created or dropped.
.PARAMETER ServerName
The host name of the SQL Server to be configured.
.PARAMETER InstanceName
The name of the SQL instance to be configured.
.PARAMETER Collation
The name of the SQL collation to use for the new database.
Defaults to server collation.
#>
function Test-TargetResource
{
[CmdletBinding()]
[OutputType([System.Boolean])]
param
(
[Parameter()]
[ValidateSet('Present', 'Absent')]
[ValidateNotNullOrEmpty()]
[System.String]
$Ensure = 'Present',
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$Name,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$ServerName,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$InstanceName,
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.String]
$Collation
)
Write-Verbose -Message "Checking if database named $Name is present or absent"
$getTargetResourceResult = Get-TargetResource @PSBoundParameters
$isDatabaseInDesiredState = $true
if (-not $PSBoundParameters.ContainsKey('Collation'))
{
$Collation = $getTargetResourceResult.Collation
}
switch ($Ensure)
{
'Absent'
{
if ($getTargetResourceResult.Ensure -ne 'Absent')
{
New-VerboseMessage -Message "Ensure is set to Absent. The database $Name should be dropped"
$isDatabaseInDesiredState = $false
}
}
'Present'
{
if ($getTargetResourceResult.Ensure -ne 'Present')
{
New-VerboseMessage -Message "Ensure is set to Present. The database $Name should be created"
$isDatabaseInDesiredState = $false
}
elseif ($getTargetResourceResult.Collation -ne $Collation)
{
New-VerboseMessage -Message 'Database exist but has the wrong collation.'
$isDatabaseInDesiredState = $false
}
}
}
$isDatabaseInDesiredState
}
Export-ModuleMember -Function *-TargetResource