Thor Logo dbatools

Invoke-DbaDbDbccCheckConstraint

View Source
Patrick Flynn (@sqllensman)
Windows, Linux, macOS

Synopsis

Validates constraint integrity by checking for constraint violations in SQL Server databases

Description

Executes DBCC CHECKCONSTRAINTS to identify rows that violate CHECK, FOREIGN KEY, and other constraints in your databases. This command helps DBAs verify data integrity after bulk imports, constraint modifications, or when troubleshooting data quality issues. You can target specific tables, individual constraints, or scan entire databases for violations. The command returns detailed information about any rows that don’t meet constraint requirements, including the table, constraint name, and violating data criteria.

Read more:
- https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-checkconstraints-transact-sql

Syntax

Invoke-DbaDbDbccCheckConstraint
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-Object] <String>]
    [-AllConstraints]
    [-AllErrorMessages]
    [-NoInformationalMessages]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Invoke-DbaDbDbccCheckConstraint -SqlInstance SqlServer2017

Runs the command DBCC CHECKCONSTRAINTS to check all enabled constraints on all tables for all databases for the instance SqlServer2017. Connect using Windows Authentication

Example: 2
PS C:\> Invoke-DbaDbDbccCheckConstraint -SqlInstance SqlServer2017 -Database CurrentDB

Connect to instance SqlServer2017 using Windows Authentication and run the command DBCC CHECKCONSTRAINTS to check all enabled constraints on all tables in the CurrentDB database.

Example: 3
PS C:\> Invoke-DbaDbDbccCheckConstraint -SqlInstance SqlServer2017 -Database CurrentDB -Object Sometable

Connects to CurrentDB on instance SqlServer2017 using Windows Authentication and runs the command DBCC CHECKCONSTRAINTS(SometableId) to check all enabled constraints in the table.

Example: 4
PS C:\> Invoke-DbaDbDbccCheckConstraint -SqlInstance SqlServer2017 -Database CurrentDB -Object ConstraintId

Connects to CurrentDB on instance SqlServer2017 using Windows Authentication and runs the command DBCC CHECKCONSTRAINTS(ConstraintId) to check the constraint with constraint_id = ConstraintId.

Example: 5
PS C:\> $cred = Get-Credential sqladmin
PS C:\> Invoke-DbaDbDbccCheckConstraint -SqlInstance SqlServer2017 -SqlCredential $cred -Database CurrentDB -Object TableId -AllConstraints -AllErrorMessages -NoInformationalMessages

Connects to CurrentDB on instance SqlServer2017 using sqladmin credential and runs the command DBCC CHECKCONSTRAINTS(TableId) WITH ALL_CONSTRAINTS, ALL_ERRORMSGS, NO_INFOMSGS to check all enabled and
disabled constraints on the table with able_id = TableId. Returns all rows that violate constraints.

Example: 6
PS C:\> 'Sql1','Sql2/sqlexpress' | Invoke-DbaDbDbccCheckConstraint -WhatIf

Displays what will happen if command DBCC CHECKCONSTRAINTS is called against all databases on Sql1 and Sql2/sqlexpress.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

PropertyValue
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value

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.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default Value
-Database

Specifies which databases to check for constraint violations. Accepts multiple database names and supports wildcards for pattern matching.
If not specified, all accessible databases on the instance will be processed. Use this when you need to target specific databases instead of checking the entire instance.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default Value
-Object

Specifies the table or constraint to check for violations. Accepts either table names, constraint names, or their numeric IDs.
When targeting a table, all enabled constraints on that table are validated. When targeting a specific constraint, only that constraint is checked.
Use this when you need to focus on a specific table after bulk data operations or when investigating a known problematic constraint.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default Value
-AllConstraints

Forces checking of both enabled and disabled constraints on the specified table or all tables in the database.
By default, only enabled constraints are validated. Use this when you need to verify data integrity against all constraint definitions, including those temporarily disabled during maintenance
operations.
Has no effect when checking a specific constraint by name or ID.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
-AllErrorMessages

Returns all constraint violation rows instead of limiting output to the first 200 violations per constraint.
Use this when you need a complete inventory of data quality issues, especially after bulk imports or when preparing comprehensive data cleanup reports.
Be cautious with large tables as this can generate extensive output.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
-NoInformationalMessages

Suppresses informational messages like “DBCC execution completed” and processing status updates.
Use this when automating constraint checks in scripts where you only want to capture actual constraint violations, not DBCC status messages.
Helpful for cleaner output when processing multiple databases or integrating results into monitoring systems.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
-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.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

PropertyValue
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
-Confirm

Prompts you for confirmation before running the cmdlet.

PropertyValue
Aliascf
RequiredFalse
Pipelinefalse
Default Value