functions/Clear-DbaSqlConnectionPool.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
function Clear-DbaSqlConnectionPool {
<#
 .SYNOPSIS
  Resets (or empties) the connection pool.
 
 .DESCRIPTION
  This command resets (or empties) the connection pool.
 
  If there are connections in use at the time of the call, they are marked appropriately and will be discarded (instead of being returned to the pool) when Close() is called on them.
 
  Ref: https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.clearallpools(v=vs.110).aspx
 
 .PARAMETER ComputerName
  Target computer(s). If no computer name is specified, the local computer is targeted.
 
 .PARAMETER Credential
  Alternate credential object to use for accessing the target computer(s).
 
 .PARAMETER EnableException
  By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
  This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
  Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
   
 .NOTES
  Tags: Connection
 
  Website: https://dbatools.io
  Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
  License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
 .LINK
  https://dbatools.io/Clear-DbaSqlConnectionPool
 
 .EXAMPLE
  Clear-DbaSqlConnectionPool
 
  Clears all local connection pools.
 
 .EXAMPLE
  Clear-DbaSqlConnectionPool -ComputerName workstation27
 
  Clears all connection pools on workstation27.
#>

    [CmdletBinding()]
    param (
        [Parameter(ValueFromPipeline = $true)]
        [Alias("cn", "host", "Server")]
        [DbaInstanceParameter[]]$ComputerName = $env:COMPUTERNAME,
        [PSCredential]$Credential,
        [switch][Alias('Silent')]$EnableException
    )
    
    process {
        # TODO: https://jamessdixon.wordpress.com/2013/01/22/ado-net-and-connection-pooling
        
        foreach ($computer in $ComputerName) {
            if (-not $computer.IsLocalhost) {
                Write-Message -Level Verbose -Message "Clearing all pools on remote computer $computer"
                if (Test-Bound 'Credential') {
                    Invoke-Command2 -ComputerName $computer -Credential $Credential -ScriptBlock { [System.Data.SqlClient.SqlConnection]::ClearAllPools() }
                }
                else {
                    Invoke-Command2 -ComputerName $computer -ScriptBlock { [System.Data.SqlClient.SqlConnection]::ClearAllPools() }
                }
            }
            else {
                Write-Message -Level Verbose -Message "Clearing all local pools"
                if (Test-Bound 'Credential') {
                    Invoke-Command2 -Credential $Credential -ScriptBlock { [System.Data.SqlClient.SqlConnection]::ClearAllPools() }
                }
                else {
                    Invoke-Command2 -ScriptBlock { [System.Data.SqlClient.SqlConnection]::ClearAllPools() }
                }
            }
        }
    }
}