functions/Update-SqlWhoIsActive.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
Function Update-SqlWhoIsActive
{
<#
.SYNOPSIS
Automatically updates sp_WhoIsActive by Adam Machanic.
 
.DESCRIPTION
If -Path is not specified, this command downloads, extracts and updates sp_whoisactive with Adam's permission.
 
To read more about sp_WhoIsActive, please visit http://sqlblog.com/blogs/adam_machanic/archive/tags/who+is+active/default.aspx
 
Also, consider donating to Adam if you find this stored procedure helpful: http://tinyurl.com/WhoIsActiveDonate
 
.PARAMETER SqlServer
The SQL Server instance.
 
.PARAMETER Path
Specify a path to file, otherwise it will automatically download it from the Internet. This is useful for disconnected networks.
 
.PARAMETER OutputDatabaseName
Return the name of the database intead of the success message
  
.PARAMETER Force
The script checks to see if sp_whoisactivesql is in $temp already, then installs it (useful when updating muliple servers at once).
  
Use Force to go download the script from the Internet, even if it's already in temp.
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$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 OutputDatabaseName
Outputs just the database name instead of the success message
 
.PARAMETER Header
To update, select a database or hit cancel to quit.
 
.NOTES
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/Update-SqlWhoIsActive
 
.EXAMPLE
Update-SqlWhoIsActive -SqlServer sqlserver2014a -Database master
 
Updates sp_WhoIsActive to sqlserver2014a's master database. Logs in using Windows Authentication.
  
.EXAMPLE
Update-SqlWhoIsActive -SqlServer sqlserver2014a -SqlCredential $cred
 
Pops up a dialog box asking which database on sqlserver2014a you want to install the proc to. Logs into SQL Server using SQL Authentication.
  
#>


[CmdletBinding()]
Param (
[parameter(Mandatory = $true, ValueFromPipeline = $true)]
[Alias("ServerInstance", "SqlInstance")]
[object[]]$SqlServer,
[object]$SqlCredential,
[switch]$OutputDatabaseName,
[string]$Header = "To update, select a database or hit cancel to quit.",
[switch]$Force
)

DynamicParam { if ($sqlserver) { return Get-ParamSqlDatabase -SqlServer $sqlserver[0] -SqlCredential $SqlCredential } }

END
{
$Database = $psboundparameters.Database

if ($Database.length -eq 0)
{
Install-SqlWhoIsActive -SqlServer $sqlserver -SqlCredential $SqlCredential -OutputDatabaseName:$OutputDatabaseName
}
else
{
Install-SqlWhoIsActive -SqlServer $sqlserver -SqlCredential $SqlCredential -Database $database -OutputDatabaseName:$OutputDatabaseName
}
}
}