Thor Logo dbatools

Get-DbaDbCheckConstraint

View Source
Claudio Silva (@ClaudioESSilva), claudioessilva.eu
Windows, Linux, macOS

Synopsis

Gets database Check constraints.

Description

Gets database Checks constraints.

Syntax

Get-DbaDbCheckConstraint
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemTable]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaDbCheckConstraint -SqlInstance sql2016

Gets all database check constraints.

Example: 2
PS C:\> Get-DbaDbCheckConstraint -SqlInstance Server1 -Database db1

Gets the check constraints for the db1 database.

Example: 3
PS C:\> Get-DbaDbCheckConstraint -SqlInstance Server1 -ExcludeDatabase db1

Gets the check constraints for all databases except db1.

Example: 4
PS C:\> Get-DbaDbCheckConstraint -SqlInstance Server1 -ExcludeSystemTable

Gets the check constraints for all databases that are not system objects.

Example: 5
PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbCheckConstraint

Gets the check constraints for the 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 search for check constraints. Accepts wildcards and multiple database names.
Use this when you need to examine constraints on specific databases rather than all accessible databases on the instance.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default Value
-ExcludeDatabase

Excludes specific databases from the check constraint search. Accepts multiple database names.
Useful when you want to scan most databases but skip certain ones like development or temporary databases.

PropertyValue
Alias
RequiredFalse
Pipelinefalse
Default Value
-ExcludeSystemTable

Excludes check constraints from system tables when searching through databases.
Use this to focus only on user-created tables and avoid system table constraints that are typically not relevant for DBA reviews.

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