< Back
Clear-DbaPlanCache
Post
NAME Clear-DbaPlanCache
SYNOPSIS
Removes ad-hoc and prepared plan caches is single use plans are over defined threshold.
SYNTAX
Clear-DbaPlanCache [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Threshold] <Int>] [[-InputObject] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Checks ad-hoc and prepared plan cache for each database, if over 100 MBs removes from the cache.
This command automates that process.
References:
https://www.sqlskills.com/blogs/kimberl ... che-bloat/
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Enables results to be piped in from Get-DbaPlanCache.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Threshold [<Int>]
Memory used threshold.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Memory
Author: Tracy Boggiano, databasesuperhero.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Clear-DbaPlanCache -SqlInstance sql2017 -Threshold 200
Logs into the SQL Server instance "sql2017" and removes plan caches if over 200 MB.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Clear-DbaPlanCache -SqlInstance sql2017 -SqlCredential sqladmin
Logs into the SQL instance using the SQL Login 'sqladmin' and then Windows instance as 'ad\\sqldba'
and removes if Threshold over 100 MB.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Find-DbaInstance -ComputerName localhost | Get-DbaPlanCache | Clear-DbaPlanCache -Threshold 200
Scans localhost for instances using the browser service, traverses all instances and gets the plan cache for each,
clears them out if they are above 200 MB.
RELATED LINKS
https://dbatools.io/Clear-DbaPlanCache
SYNOPSIS
Removes ad-hoc and prepared plan caches is single use plans are over defined threshold.
SYNTAX
Clear-DbaPlanCache [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Threshold] <Int>] [[-InputObject] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Checks ad-hoc and prepared plan cache for each database, if over 100 MBs removes from the cache.
This command automates that process.
References:
https://www.sqlskills.com/blogs/kimberl ... che-bloat/
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Enables results to be piped in from Get-DbaPlanCache.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Threshold [<Int>]
Memory used threshold.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Memory
Author: Tracy Boggiano, databasesuperhero.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Clear-DbaPlanCache -SqlInstance sql2017 -Threshold 200
Logs into the SQL Server instance "sql2017" and removes plan caches if over 200 MB.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Clear-DbaPlanCache -SqlInstance sql2017 -SqlCredential sqladmin
Logs into the SQL instance using the SQL Login 'sqladmin' and then Windows instance as 'ad\\sqldba'
and removes if Threshold over 100 MB.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Find-DbaInstance -ComputerName localhost | Get-DbaPlanCache | Clear-DbaPlanCache -Threshold 200
Scans localhost for instances using the browser service, traverses all instances and gets the plan cache for each,
clears them out if they are above 200 MB.
RELATED LINKS
https://dbatools.io/Clear-DbaPlanCache