Get-DbaDbSynonym

Synopsis

Retrieves database synonyms and their target object mappings from SQL Server instances

Description

Returns database synonym objects along with their target object details including base server, database, schema, and object name. Synonyms are database-scoped aliases that point to objects in the same or different databases, even on remote servers. This function helps DBAs document database dependencies, track cross-database references, and analyze synonym usage across their SQL Server environment. The output includes both the synonym definition and its underlying target, making it useful for impact analysis when planning database migrations or refactoring.

Syntax

Get-DbaDbSynonym
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [[-Schema] <String[]>]
    [[-ExcludeSchema] <String[]>]
    [[-Synonym] <String[]>]
    [[-ExcludeSynonym] <String[]>]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbSynonym -SqlInstance localhost

Returns all database synonyms in all databases on the local default SQL Server instance

Example: 2

PS C:\> Get-DbaDbSynonym -SqlInstance localhost, sql2016

Returns all synonyms of all database(s) on the local and sql2016 SQL Server instances

Example: 3

PS C:\> $servers = Get-Content C:\servers.txt
PS C:\> $servers | Get-DbaDbSynonym

Returns synonyms of all database(s) for every server in C:\servers.txt

Example: 4

PS C:\> Get-DbaDbSynonym -SqlInstance localhost -Database db1

Returns synonyms of the database db1 on localhost.

Example: 5

PS C:\> Get-DbaDbSynonym -SqlInstance localhost -Database db1 -Synonym 'synonym1'

Returns the synonym1 synonym in the db1 database on localhost.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

-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

Specifies which database(s) to search for synonyms. Accepts wildcards for pattern matching.
Use this when you need to focus on specific databases instead of scanning all databases on the instance.

-ExcludeDatabase

Excludes specific database(s) from the synonym search. Accepts wildcards for pattern matching.
Useful for skipping system databases, test environments, or databases you know don’t contain relevant synonyms.

-Schema

Filters synonyms to only those in the specified schema(s). Accepts wildcards for pattern matching.
Use this when you need to focus on synonyms within specific schemas, such as application-specific or departmental schemas.

-ExcludeSchema

Excludes synonyms from specific schema(s) in the results. Accepts wildcards for pattern matching.
Helpful for filtering out system schemas or schemas that contain synonyms you’re not interested in analyzing.

-Synonym

Specifies exact synonym name(s) to retrieve. Accepts multiple synonym names as an array.
Use this when you need details about specific synonyms, such as checking where a particular synonym points or verifying its target object.

-ExcludeSynonym

Excludes specific synonym(s) from the results by name. Accepts multiple synonym names as an array.
Useful when you want to see all synonyms except certain ones you already know about or don’t need to review.

-InputObject

Accepts database objects from Get-DbaDatabase via pipeline input. Allows you to chain database filtering commands.
Use this to process synonyms only from databases that meet specific criteria, such as specific compatibility levels or last backup dates.

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

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts you for confirmation before executing any changing operations within the command.