Get-DbaDbForeignKey

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

Synopsis

Gets database Foreign Keys.

Description

Gets database Foreign Keys.

Syntax

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

Examples

Example: 1

PS C:\> Get-DbaDbForeignKey -SqlInstance sql2016

Gets all database Foreign Keys.

Example: 2

PS C:\> Get-DbaDbForeignKey -SqlInstance Server1 -Database db1

Gets the Foreign Keys for the db1 database.

Example: 3

PS C:\> Get-DbaDbForeignKey -SqlInstance Server1 -ExcludeDatabase db1

Gets the Foreign Keys for all databases except db1.

Example: 4

PS C:\> Get-DbaDbForeignKey -SqlInstance Server1 -ExcludeSystemTable

Gets the Foreign Keys from all tables that are not system objects from all databases.

Example: 5

PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbForeignKey

Gets the Foreign Keys for the databases on Sql1 and Sql2/sqlexpress.

Required Parameters

-SqlInstance

The target SQL Server instance or instances

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.

-Database

To get Foreign Keys from specific database(s)

-ExcludeDatabase

The database(s) to exclude - this list is auto populated from the server

-ExcludeSystemTable

This switch removes all system objects from the tables collection

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