functions/Install-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
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
Function Install-SqlWhoIsActive
{
<#
.SYNOPSIS
Automatically installs or updates sp_WhoIsActive by Adam Machanic.

.DESCRIPTION
This command downloads, extracts and installs sp_whoisactive with Adam's permission. To read more about sp_WhoIsActive, please visit:

Updates: 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.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. 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

.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/Install-SqlWhoIsActive

.EXAMPLE
Install-SqlWhoIsActive -SqlServer sqlserver2014a -Database master

Installs sp_WhoIsActive to sqlserver2014a's master database. Logs in using Windows Authentication.
    
.EXAMPLE
Install-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,
        [string]$Path,
        [switch]$OutputDatabaseName,
        [string]$Header = "sp_WhoIsActive not found. To deploy, select a database or hit cancel to quit."
    )
    
    DynamicParam { if ($sqlserver) { return Get-ParamSqlDatabase -SqlServer $sqlserver -SqlCredential $SqlCredential } }
    
    BEGIN
    {
        
        # please continue to use these variable names for consistency
        $sourceserver = Connect-SqlServer -SqlServer $sqlserver -SqlCredential $SqlCredential
        $source = $sourceserver.DomainInstanceName
        
        Function Get-SpWhoIsActive
        {
            
            $url = 'http://sqlblog.com/files/folders/42453/download.aspx'
            $temp = ([System.IO.Path]::GetTempPath()).TrimEnd("\")
            $zipfile = "$temp\spwhoisactive.zip"
            
            try
            {
                Invoke-WebRequest $url -OutFile $zipfile
            }
            catch
            {
                #try with default proxy and usersettings
                (New-Object System.Net.WebClient).Proxy.Credentials = [System.Net.CredentialCache]::DefaultNetworkCredentials
                Invoke-WebRequest $url -OutFile $zipfile
            }
            
            # Unblock if there's a block
            Unblock-File $zipfile -ErrorAction SilentlyContinue
            
            # Keep it backwards compatible
            $shell = New-Object -COM Shell.Application
            $zipPackage = $shell.NameSpace($zipfile)
            $destinationFolder = $shell.NameSpace($temp)
            $destinationFolder.CopyHere($zipPackage.Items())
            
            Remove-Item -Path $zipfile
        }
        
        # Used a dynamic parameter? Convert from RuntimeDefinedParameter object to regular array
        $Database = $psboundparameters.Database
        
        if ($Header -like '*update*')
        {
            $action = "update"
        }
        else
        {
            $action = "install"
        }
        
        $textinfo = (Get-Culture).TextInfo
        $actiontitle = $textinfo.ToTitleCase($action)
        
        if ($action -eq "install")
        {
            $actioning = "installing"
        }
        else
        {
            $actioning = "updating"
        }
    }
    
    PROCESS
    {
        
        if ($database.length -eq 0)
        {
            $database = Show-SqlDatabaseList -SqlServer $sourceserver -Title "$actiontitle sp_WhoisActive" -Header $header -DefaultDb "master"
            
            if ($database.length -eq 0)
            {
                throw "You must select a database to $action the procedure"
            }
            
            if ($database -ne 'master')
            {
                Write-Warning "You have selected a database other than master. When you run Show-SqlWhoIsActive in the future, you must specify -Database $database"
            }
        }
        
        if ($Path.Length -eq 0)
        {
            $temp = ([System.IO.Path]::GetTempPath()).TrimEnd("\")
            $path = (Get-ChildItem "$temp\who*active*.sql" | Select -First 1).FullName
            
            if ($path.Length -eq 0)
            {
                try
                {
                    Write-Output "Downloading sp_WhoIsActive zip file, unzipping and $actioning."
                    Get-SpWhoIsActive
                }
                catch
                {
                    throw "Couldn't download sp_WhoIsActive. Please download and $action manually from http://sqlblog.com/files/folders/42453/download.aspx."
                }
            }
            
            $path = (Get-ChildItem "$temp\who*active*.sql" | Select -First 1).Name
            $path = "$temp\$path"
        }
        
        if ((Test-Path $Path) -eq $false)
        {
            throw "Invalid path at $path"    
        }
        
        $sql = [IO.File]::ReadAllText($path)
        $sql = $sql -replace 'USE master', ''
        $batches = $sql -split "GO\r\n"
        
        foreach ($batch in $batches)
        {
            try
            {
                $null = $sourceserver.databases[$database].ExecuteNonQuery($batch)
                
            }
            catch
            {
                Write-Exception $_
                throw "Can't $action stored procedure. See exception text for details."
            }
        }
    }
    
    END
    {
        $sourceserver.ConnectionContext.Disconnect()
        
        if ($OutputDatabaseName -eq $true)
        {
            return $database
        }
        else
        {
            Write-Output "Finished $actioning sp_WhoIsActive in $database on $SqlServer "
        }
    }
}