functions/Install-DbaWhoIsActive.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
Function Install-DbaWhoIsActive {
<#
.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
     
Note that you will be prompted a bunch of times to confirm an action. To disable this behavior, pass the -Confirm:$false parameter (see example below).
 
.PARAMETER SqlInstance
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 WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.PARAMETER Silent
Use this switch to disable any kind of verbose messages or progress bars
     
.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-DbaWhoIsActive
 
.EXAMPLE
Install-DbaWhoIsActive -SqlInstance sqlserver2014a -Database master
 
Installs sp_WhoisActive to sqlserver2014a's master database. Logs in using Windows Authentication.
     
.EXAMPLE
Install-DbaWhoIsActive -SqlInstance sqlserver2014a -SqlCredential $cred -Confirm:$false
 
Pops up a dialog box asking which database on sqlserver2014a you want to install the proc to. Logs into SQL Server using SQL Authentication.
     
Does not prompt multiple times.
 
.EXAMPLE
$instances = Get-SqlRegisteredServerName sqlserver
Install-DbaWhoIsActive -SqlInstance $instances -Database master
 
This command doesn't support passing both servers and default database, but you can accomplish the same thing by passing an array and specifying a database.
 
#>

    
    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
    param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [PsCredential]$SqlCredential,
        [switch]$Silent
    )
    
    dynamicparam { if ($SqlInstance) { return Get-ParamSqlDatabase -SqlServer $SqlInstance[0] -SqlCredential $SqlCredential } }
    
    begin {
        
        $temp = ([System.IO.Path]::GetTempPath()).TrimEnd("\")
        $sqlfile = (Get-ChildItem "$temp\who*active*.sql" | Select-Object -First 1).FullName
        
        if ($sqlfile) {
            Write-Message -Level Output -Message "Found $sqlfile"
        }
        else {
            Write-Message -Level Verbose -Message "No $sqlfile found, downloading"
            
            if ($PSCmdlet.ShouldProcess($env:computername, "Downloading sp_WhoisActive")) {
                try {
                    if ($OutputDatabaseName -eq $false) {
                        Write-Message -Level Output -Message "Downloading sp_WhoisActive zip file, unzipping and installing."
                    }
                    $url = 'http://whoisactive.com/who_is_active_v11_17.zip'
                    $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 -ComObject Shell.Application
                    $zipPackage = $shell.NameSpace($zipfile)
                    $destinationFolder = $shell.NameSpace($temp)
                    $destinationFolder.CopyHere($zipPackage.Items())
                    
                    Remove-Item -Path $zipfile
                    
                    $sqlfile = (Get-ChildItem "$temp\who*active*.sql" | Select-Object -First 1).Name
                    $sqlfile = "$temp\$sqlfile"
                }
                catch {
                    Stop-Function -Message "Couldn't download sp_WhoisActive. Please download and install manually from http://whoisactive.com/who_is_active_v11_17.zip." -InnerErrorRecord $_
                    return
                }
            }
        }
        
        if ($PSCmdlet.ShouldProcess($env:computername, "Reading SQL file into memory")) {
            Write-Message -Level Output -Message "Using $sqlfile"
            
            $sql = [IO.File]::ReadAllText($sqlfile)
            $sql = $sql -replace 'USE master', ''
            $batches = $sql -split "GO\r\n"
        }
        
        $Database = $psboundparameters.Database
    }
    
    process {
        if (Test-FunctionInterrupt) { return }
        
        foreach ($instance in $SqlInstance) {
            try {
                Write-Message -Level Verbose -Message "Connecting to $instance"
                $server = Connect-SqlServer -SqlServer $instance -SqlCredential $sqlcredential
            }
            catch {
                Stop-Function -Message "Failed to connect to $instance : $($_.Exception.Message)" -Continue -Target $instance -InnerErrorRecord $_
            }
            
            if (-not $database) {
                if ($PSCmdlet.ShouldProcess($instance, "Prompting with GUI list of databases")) {
                    $database = Show-SqlDatabaseList -SqlServer $server -Title "Install sp_WhoisActive" -Header "To deploy sp_WhoisActive, select a database or hit cancel to quit." -DefaultDb "master"
                    
                    if (-not $database) {
                        Stop-Function -Message "You must select a database to install the procedure" -Target $database
                        return
                    }
                    
                    if ($database -ne 'master') {
                        Write-Message -Level Warning -Message "You have selected a database other than master. When you run Show-SqlWhoIsActive in the future, you must specify -Database $database"
                    }
                }
            }
            
            if ($PSCmdlet.ShouldProcess($instance, "Installing sp_WhoisActive")) {
                foreach ($batch in $batches) {
                    try {
                        $null = $server.databases[$database].ExecuteNonQuery($batch)
                    }
                    catch {
                        Stop-Function -Message "Can't install stored procedure. $_" -InnerErrorRecord $_
                        return
                    }
                }
                
                Write-Message -Level Output -Message "Finished installing/updating sp_WhoisActive in $database on $instance"
            }
        }
    }
    end {
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -Alias Install-SqlWhoIsActive
    }
}