< Back
Get-DbaDbForeignKey
Post
NAME Get-DbaDbForeignKey
SYNOPSIS
Gets database Foreign Keys.
SYNTAX
Get-DbaDbForeignKey [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>] [-ExcludeSystemTable
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets database Foreign Keys.
PARAMETERS
-Database [<System.Object[]>]
To get Foreign Keys from specific database(s)
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
-ExcludeDatabase [<System.Object[]>]
The database(s) to exclude - this list is auto populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeSystemTable [<Switch>]
This switch removes all system objects from the tables collection
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: Database,ForeignKey, Table
Author: Claudio Silva (@ClaudioESSilva), https://claudioessilva.eu
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
SYNOPSIS
Gets database Foreign Keys.
SYNTAX
Get-DbaDbForeignKey [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>] [-ExcludeSystemTable
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets database Foreign Keys.
PARAMETERS
-Database [<System.Object[]>]
To get Foreign Keys from specific database(s)
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
-ExcludeDatabase [<System.Object[]>]
The database(s) to exclude - this list is auto populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeSystemTable [<Switch>]
This switch removes all system objects from the tables collection
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: Database,ForeignKey, Table
Author: Claudio Silva (@ClaudioESSilva), https://claudioessilva.eu
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS