commands

^

Get-DbaDbSynonym

Author Mikey Bronowski (@MikeyBronowski), https://bronowski.it
Availability Windows, Linux, macOS

 

Synopsis

Get the synonym(s) for database(s) / instance(s) of SQL Server.

Description

The Get-DbaDbSynonym returns the synonym(s) for database(s) / instance(s) of SQL Server.

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.

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value
-Database

The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeDatabase

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

Alias
Required False
Pipeline false
Default Value
-Schema

The schema(s) to process. If unspecified, all schemas will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeSchema

The schema(s) to exclude.

Alias
Required False
Pipeline false
Default Value
-Synonym

The synonym(s) to process. If unspecified, all synonyms will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeSynonym

The synonym(s) to exclude.

Alias
Required False
Pipeline false
Default Value
-InputObject

Enables piped input from Get-DbaDatabase

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

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

Alias wi
Required False
Pipeline false
Default Value
-Confirm

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

Alias cf
Required False
Pipeline false
Default Value

 

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