forked from mmessano/PowerShell
-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathExtractDatabaseDocumentation.ps1
469 lines (430 loc) · 17.9 KB
/
ExtractDatabaseDocumentation.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
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# FIXME
# scripting SQL accounts is problematic at best
# the scripter replaces the password with random text which also breaks the
# continuity of the file. SSMS does this as well so it is a SQL bug most likely
param (
$Server
);
# Load needed assemblies
[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SqlServer.SMO") | Out-Null;
[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SqlServer.SMOExtended")| Out-Null;
# Simple function to write html pages
function writeHtmlPage
{
param ($title, $heading, $body, $filePath);
$html = "<html>
<head>
<title>$title</title>
</head>
<body>
<h1>$heading</h1>
$body
</body>
</html>";
$html | Out-File -FilePath $filePath;
}
# Return all user databases on a sql server
function getDatabases
{
param ($sql_server);
$databases = $sql_server.Databases | Where-Object {$_.IsSystemObject -eq $false};
return $databases;
}
# Get all schemata in a database
function getDatabaseSchemata
{
param ($sql_server, $database);
$db_name = $database.Name;
$schemata = $sql_server.Databases[$db_name].Schemas;
foreach ($schema in $schemata)
{
if ( $schema.Owner -match '\\' )
{$schema.Owner = $schema.Owner -replace '\\', '-'};
}
return $schemata;
}
# Get all tables in a database
function getDatabaseTables
{
param ($sql_server, $database);
$db_name = $database.Name;
$tables = $sql_server.Databases[$db_name].Tables | Where-Object {$_.IsSystemObject -eq $false};
return $tables;
}
# Get all stored procedures in a database
function getDatabaseStoredProcedures
{
param ($sql_server, $database);
$db_name = $database.Name;
$procs = $sql_server.Databases[$db_name].StoredProcedures | Where-Object {$_.IsSystemObject -eq $false};
return $procs;
}
# Get all user defined functions in a database
function getDatabaseFunctions
{
param ($sql_server, $database);
$db_name = $database.Name;
$functions = $sql_server.Databases[$db_name].UserDefinedFunctions | Where-Object {$_.IsSystemObject -eq $false};
return $functions;
}
# Get all views in a database
function getDatabaseViews
{
param ($sql_server, $database);
$db_name = $database.Name;
$views = $sql_server.Databases[$db_name].Views | Where-Object {$_.IsSystemObject -eq $false};
return $views;
}
# Get all table triggers in a database
function getDatabaseTriggers
{
param ($sql_server, $database);
$db_name = $database.Name;
$tables = $sql_server.Databases[$db_name].Tables | Where-Object {$_.IsSystemObject -eq $false};
$triggers = $null;
foreach($table in $tables)
{
$triggers += $table.Triggers;
}
return $triggers;
}
function getDBLogins
{
param ($sql_server, $database);
$db_name = $database.Name;
$logins = $sql_server.Databases[$db_name].Users;# | Where-Object {$_.IsSystemObject -eq $false};
return $logins;
}
# server level
function getLogins
{
param ($sql_server);
$logins = $sql_server.Logins | Where-Object {$_.IsSystemObject -eq $false};
return $logins;
}
# Server level
function getLinkedServers
{
param ($sql_server);
$linkedservers = $sql_server.LinkedServers;
return $linkedservers;
}
function getJobs
{
param ($sql_server);
$jobs = $sql_server.JobServer.Jobs;
return $jobs;
}
# This function builds a list of links for database object types
function buildLinkList
{
param ($array, $path);
$output = "<ul>";
foreach($item in $array)
{
if($item.IsSystemObject -eq $false) # Exclude system objects
{
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Schema")
{
$output += "`n<li><a href=`"$path" + $item.Owner + ".html`">" + $item.Name + "</a></li>";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Trigger")
{
$output += "`n<li><a href=`"$path" + $item.Parent.Schema + "." + $item.Name + ".html`">" + $item.Parent.Schema + "." + $item.Name + "</a></li>";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Login")
{
# Leave the href name unmodified so accounts show up as DOMAIN\ACCOUNT but the link is correct
$output += "`n<li><a href=`"$path" + ($item.Name -replace "\\", "-") + ".html`">" + $item.Name + "</a></li>";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.User")
{
# Leave the href name unmodified so accounts show up as DOMAIN\ACCOUNT but the link is correct
$output += "`n<li><a href=`"$path" + ($item.Name -replace "\\", "-") + ".html`">" + $item.Name + "</a></li>";
}
else
{
#Write-Host "buildLinkList Default";
$output += "`n<li><a href=`"$path" + $item.Schema + "." + $item.Name + ".html`">" + $item.Schema + "." + $item.Name + "</a></li>";
}
}
elseif($item.IsSystemObject -eq $true)
{
# Write-Host "buildlinkList else statement";
# Write-Host $item;
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Agent.Job")
{
$output += "`n<li><a href=`"$path" + $item + ".html`">" + $item + "</a></li>";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.LinkedServer")
{
$output += "`n<li><a href=`"$path" + $item.Name + ".html`">" + $item.Name + "</a></li>";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.User")
{
# Leave the href name unmodified so accounts show up as DOMAIN\ACCOUNT but the link is correct
$output += "`n<li><a href=`"$path" + ($item.Name -replace "\\", "-") + ".html`">" + $item.Name + "</a></li>";
}
}
}
$output += "</ul>";
return $output;
}
# Return the DDL for a given database object
function getObjectDefinition
{
param ($item);
$definition = "";
# Schemas don't like our scripting options
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Schema")
{
$definition = $item.Script();
}
else
{
$options = New-Object ('Microsoft.SqlServer.Management.Smo.ScriptingOptions');
$options.DriAll = $true;
$options.Indexes = $true;
$definition = $item.Script($options);
#Write-Host $item.Script($options);
}
return "<pre>$definition</pre>";
}
# This function will get the comments on objects
# MS calls these MS_Description when you add them through SSMS
function getDescriptionExtendedProperty
{
param ($item);
$description = "No extended property documentation on object.";
foreach($property in $item.ExtendedProperties)
{
#if($property.Name -eq "MS_Description")
#{
$description = $property.Value;
#}
}
return $description;
}
# Gets the parameters for a Stored Procedure
function getProcParameterTable
{
param ($proc);
$proc_params = $proc.Parameters;
$prms = $proc_params | ConvertTo-Html -Fragment -Property Name, DataType, DefaultValue, IsOutputParameter;
return $prms;
}
# Returns a html table of column details for a db table
function getTableColumnTable
{
param ($table);
$table_columns = $table.Columns;
$objs = @();
foreach($column in $table_columns)
{
$obj = New-Object -TypeName Object;
$description = getDescriptionExtendedProperty $column;
Add-Member -Name "Name" -MemberType NoteProperty -Value $column.Name -InputObject $obj;
Add-Member -Name "DataType" -MemberType NoteProperty -Value $column.DataType -InputObject $obj;
Add-Member -Name "Default" -MemberType NoteProperty -Value $column.Default -InputObject $obj;
Add-Member -Name "Identity" -MemberType NoteProperty -Value $column.Identity -InputObject $obj;
Add-Member -Name "InPrimaryKey" -MemberType NoteProperty -Value $column.InPrimaryKey -InputObject $obj;
Add-Member -Name "IsForeignKey" -MemberType NoteProperty -Value $column.IsForeignKey -InputObject $obj;
Add-Member -Name "Description" -MemberType NoteProperty -Value $description -InputObject $obj;
$objs = $objs + $obj;
}
$cols = $objs | ConvertTo-Html -Fragment -Property Name, DataType, Default, Identity, InPrimaryKey, IsForeignKey, Description;
return $cols;
}
# Returns a html table containing trigger details
function getTriggerDetailsTable
{
param ($trigger);
$trigger_details = $trigger | ConvertTo-Html -Fragment -Property IsEnabled, CreateDate, DateLastModified, Delete, DeleteOrder, Insert, InsertOrder, Update, UpdateOrder;
return $trigger_details;
}
# This function creates all the html pages for our database objects
function createObjectTypePages
{
param ($objectName, $objectArray, $filePath, $db);
New-Item -Path $($filePath + $db.Name + "\$objectName") -ItemType directory -Force | Out-Null;
# Create index page for object type
$page = $filePath + $($db.Name) + "\$objectName\index.html";
$list = buildLinkList $objectArray "";
if($objectArray -eq $null)
{
$list = "No $objectName in $db";
}
writeHtmlPage $objectName $objectName $list $page;
# Individual object pages
if($objectArray.Count -gt 0)
{
foreach ($item in $objectArray)
{
if($item.IsSystemObject -eq $false) # Exclude system objects
{
$description = getDescriptionExtendedProperty($item);
$body = "<h2>Description</h2>$description";
$definition = getObjectDefinition $item;
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Schema")
{
$page = $filePath + $($db.Name + "\$objectName\" + $item.Owner + ".html");
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Trigger")
{
$page = $filePath + $($db.Name + "\$objectName\" + $item.Parent.Schema + "." + $item.Name + ".html");
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Login")
{
$page = $filePath + $($db.Name + "\$objectname\" + ($item.Name -replace "\\", "-") + ".html");
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.User")
{
$page = $filePath + $($db.Name + "\$objectname\" + ($item.Name -replace "\\", "-") + ".html");
}
else
{
$page = $filePath + $($db.Name + "\$objectName\" + $item.Schema + "." + $item.Name + ".html");
}
$title = "";
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Schema")
{
$title = $item.Name;
$body += "<h2>Object Definition</h2>$definition";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Login")
{
$title = $item.Name;
$body += "<h2>Object Definition</h2>$definition";
}
else
{
$title = $item.Schema + "." + $item.Name;
if(([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.StoredProcedure") -or ([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.UserDefinedFunction"))
{
$proc_params = getProcParameterTable $item;
$body += "<h2>Parameters</h2>$proc_params<h2>Object Definition</h2>$definition";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Table")
{
$cols = getTableColumnTable $item;
$body += "<h2>Columns</h2>$cols<h2>Object Definition</h2>$definition";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.View")
{
$cols = getTableColumnTable $item;
$body += "<h2>Columns</h2>$cols<h2>Object Definition</h2>$definition";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Trigger")
{
$title = $item.Parent.Schema + "." + $item.Name;
$trigger_details = getTriggerDetailsTable $item;
$body += "<h2>Details</h2>$trigger_details<h2>Object Definition</h2>$definition";
}
# elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Login")
# {
# $body += "<h2>Object Definition</h2>$definition";
# }
}
}
elseif($item.IsSystemObject -eq $true) # system object
#else # system object; using ($item.IsSystemObject -eq $true) does not work as Jobs and LinkedServers do not have that property
{
$description = getDescriptionExtendedProperty($item);
$body = "<h2>Description</h2>$description";
$definition = getObjectDefinition $item;
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.Agent.Job")
{
$title = $item;
$page = $filePath + $($db.Name + "\$objectName\" + $item + ".html");
$body += "<h2>Object Definition</h2>$definition";
}
elseif([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.LinkedServer")
{
$title = $item.Name;
$page = $filePath + $($db.Name + "\$objectName\" + $item.Name + ".html");
$body += "<h2>Object Definition</h2>$definition";
}
if([string]$item.GetType() -eq "Microsoft.SqlServer.Management.Smo.User")
{
$title = $item.Name;
$page = $filePath + $($db.Name + "\$objectName\" + $item.Name + ".html");
$body += "<h2>Object Definition</h2>$definition";
}
}
writeHtmlPage $title $title $body $page;
}
}
} # end createObjectTypePages
# Root directory where the html documentation will be generated
$filePath = "$env:USERPROFILE\database_documentation\$Server\";
New-Item -Path $filePath -ItemType directory -Force | Out-Null;
# sql server that hosts the databases we wish to document
$sql_server = New-Object Microsoft.SqlServer.Management.Smo.Server $Server;
# IsSystemObject not returned by default so ask SMO for it
# not needed for LinkedServers or Jobs
$sql_server.SetDefaultInitFields([Microsoft.SqlServer.Management.SMO.Table], "IsSystemObject");
$sql_server.SetDefaultInitFields([Microsoft.SqlServer.Management.SMO.View], "IsSystemObject");
$sql_server.SetDefaultInitFields([Microsoft.SqlServer.Management.SMO.StoredProcedure], "IsSystemObject");
$sql_server.SetDefaultInitFields([Microsoft.SqlServer.Management.SMO.Trigger], "IsSystemObject");
$sql_server.SetDefaultInitFields([Microsoft.SqlServer.Management.SMO.User], "IsSystemObject");
# Get databases on our server
$databases = getDatabases $sql_server;
# Get LinkedServers for the current server
$linkedservers = getLinkedServers $sql_server;
createObjectTypePages "LinkedServers" $linkedservers $filePath;
Write-Host "Documented Linked Servers on " $sql_server.Name;
# Get jobs for the current server
$jobs = getJobs $sql_server;
createObjectTypePages "Jobs" $jobs $filePath;
Write-Host "Documented Jobs on " $sql_server.Name;
# get logins for the current server
$logins = getLogins $sql_server;
createObjectTypePages "Logins" $logins $filePath;
Write-Host "Documented Logins on " $sql_server.Name;
foreach ($db in $databases)
{
Write-Host "Started documenting " $db.Name;
# Directory for each database to keep everything tidy
New-Item -Path $($filePath + $db.Name) -ItemType directory -Force | Out-Null;
# Make a page for the database
$db_page = $filePath + $($db.Name) + "\index.html";
$body = "<ul>
<li><a href='Schemata/index.html'>Schemata</a></li>
<li><a href='Tables/index.html'>Tables</a></li>
<li><a href='Views/index.html'>Views</a></li>
<li><a href='Stored Procedures/index.html'>Stored Procedures</a></li>
<li><a href='Functions/index.html'>Functions</a></li>
<li><a href='Triggers/index.html'>Triggers</a></li>
<li><a href='Users/index.html'>Users</a></li>
</ul>";
writeHtmlPage $db $db $body $db_page;
# Get schemata for the current database
$schemata = getDatabaseSchemata $sql_server $db;
createObjectTypePages "Schemata" $schemata $filePath $db;
Write-Host "`tDocumented schemata in " $db.Name;
# Get tables for the current database
$tables = getDatabaseTables $sql_server $db;
createObjectTypePages "Tables" $tables $filePath $db;
Write-Host "Documented tables in " $db.Name;
# Get views for the current database
$views = getDatabaseViews $sql_server $db;
createObjectTypePages "Views" $views $filePath $db;
Write-Host "`tDocumented views in " $db.Name;
# Get procs for the current database
$procs = getDatabaseStoredProcedures $sql_server $db;
createObjectTypePages "Stored Procedures" $procs $filePath $db;
Write-Host "`tDocumented stored procedures in " $db.Name;
# Get functions for the current database
$functions = getDatabaseFunctions $sql_server $db;
createObjectTypePages "Functions" $functions $filePath $db;
Write-Host "`tDocumented functions in " $db.Name;
# Get triggers for the current database
$triggers = getDatabaseTriggers $sql_server $db;
createObjectTypePages "Triggers" $triggers $filePath $db;
Write-Host "`tDocumented triggers in " $db.Name;
# get logins for the current server
$logins = getDBLogins $sql_server $db;
createObjectTypePages "Users" $logins $filePath $db;
Write-Host "`tDocumented Users in " $db.Name;
Write-Host "Finished documenting " $db.Name;
}