Clear-DbaLatchStatistics

Want to see the source code for this command? Check out Clear-DbaLatchStatistics on GitHub.
Want to see the Bill Of Health for this command? Check out Clear-DbaLatchStatistics.

Synopsis

Clears Latch Statistics

Description

Reset the aggregated statistics - basically just executes DBCC SQLPERF (N'sys.dm_os_latch_stats', CLEAR)

Syntax

Clear-DbaLatchStatistics
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Clear-DbaLatchStatistics -SqlInstance sql2008, sqlserver2012

After confirmation, clears latch statistics on servers sql2008 and sqlserver2012

Example: 2

PS C:\> Clear-DbaLatchStatistics -SqlInstance sql2008, sqlserver2012 -Confirm:$false

Clears latch statistics on servers sql2008 and sqlserver2012, without prompting

Example: 3

PS C:\> 'sql2008','sqlserver2012' | Clear-DbaLatchStatistics

After confirmation, clears latch statistics on servers sql2008 and sqlserver2012

Example: 4

PS C:\> $cred = Get-Credential sqladmin
PS C:\> Clear-DbaLatchStatistics -SqlInstance sql2008 -SqlCredential $cred

Connects using sqladmin credential and clears latch statistics on servers sql2008 and sqlserver2012

Required Parameters

-SqlInstance

Allows you to specify a comma separated list of servers to query.

Optional Parameters

-SqlCredential

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.

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

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.