< Back
Invoke-DbaDbDbccCheckConstraint
Post
NAME Invoke-DbaDbDbccCheckConstraint
SYNOPSIS
Execution of Database Console Command DBCC CHECKCONSTRAINTS
SYNTAX
Invoke-DbaDbDbccCheckConstraint [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-Object] <String>] [-AllConstraints <Switch>]
[-AllErrorMessages <Switch>] [-NoInformationalMessages <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Executes the command DBCC CHECKCONSTRAINTS and returns results
Reports and corrects pages and row count inaccuracies in the catalog views.
These inaccuracies may cause incorrect space usage reports returned by the sp_spaceused system stored procedure.
Read more:
- https://docs.microsoft.com/en-us/sql/t- ... ansact-sql
PARAMETERS
-AllConstraints [<Switch>]
Checks all enabled and disabled constraints on the table if the table name is specified or if all tables are
checked;
Otherwise, checks only the enabled constraint.
Has no effect when a constraint is specified
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-AllErrorMessages [<Switch>]
Returns all rows that violate constraints in the table that is checked.
The default is the first 200 rows.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will
be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
-NoInformationalMessages [<Switch>]
Suppresses all informational messages.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Object [<String>]
The table or constraint to be checked.
When table_name or table_id is specified, all enabled constraints on that table are checked.
When constraint_name or constraint_id is specified, only that constraint is checked.
If neither a table identifier nor a constraint identifier is specified, all enabled constraints on all tables
in the current database are checked.
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
<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: DBCC
Author: Patrick Flynn (@sqllensman)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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 databses on Sql1 and
Sql2/sqlexpress
RELATED LINKS
https://dbatools.io/Invoke-DbaDbDbccCheckConstraint
SYNOPSIS
Execution of Database Console Command DBCC CHECKCONSTRAINTS
SYNTAX
Invoke-DbaDbDbccCheckConstraint [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-Object] <String>] [-AllConstraints <Switch>]
[-AllErrorMessages <Switch>] [-NoInformationalMessages <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Executes the command DBCC CHECKCONSTRAINTS and returns results
Reports and corrects pages and row count inaccuracies in the catalog views.
These inaccuracies may cause incorrect space usage reports returned by the sp_spaceused system stored procedure.
Read more:
- https://docs.microsoft.com/en-us/sql/t- ... ansact-sql
PARAMETERS
-AllConstraints [<Switch>]
Checks all enabled and disabled constraints on the table if the table name is specified or if all tables are
checked;
Otherwise, checks only the enabled constraint.
Has no effect when a constraint is specified
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-AllErrorMessages [<Switch>]
Returns all rows that violate constraints in the table that is checked.
The default is the first 200 rows.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will
be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
-NoInformationalMessages [<Switch>]
Suppresses all informational messages.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Object [<String>]
The table or constraint to be checked.
When table_name or table_id is specified, all enabled constraints on that table are checked.
When constraint_name or constraint_id is specified, only that constraint is checked.
If neither a table identifier nor a constraint identifier is specified, all enabled constraints on all tables
in the current database are checked.
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
<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: DBCC
Author: Patrick Flynn (@sqllensman)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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 databses on Sql1 and
Sql2/sqlexpress
RELATED LINKS
https://dbatools.io/Invoke-DbaDbDbccCheckConstraint