New-DbaDbSynonym

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

Synopsis

Creates database synonyms to provide alternate names for tables, views, procedures, and other database objects.

Description

Creates database synonyms that serve as alternate names or aliases for database objects like tables, views, stored procedures, and functions. Synonyms simplify object references by providing shorter names, hiding complex schema structures, or creating abstraction layers for applications. You can create synonyms that reference objects in the same database, different databases, or even on linked servers, making cross-database and cross-server object access more manageable for applications and users.

Syntax

New-DbaDbSynonym
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [[-Synonym] <String>]
    [[-Schema] <String>]
    [[-BaseServer] <String>]
    [[-BaseDatabase] <String>]
    [[-BaseSchema] <String>]
    [-BaseObject] <String>
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> New-DbaDbSynonym -SqlInstance sql2017a -Database db1 -Synonym synObj1 -BaseObject Obj1

Will create a new synonym named synObj1 in db1 database in dbo schema on sql2017a instance for Obj1 object in the same database.

Example: 2

PS C:\> New-DbaDbSynonym -SqlInstance sql2017a -Database db1 -Synonym synObj1 -BaseObject Obj1

Will create a new synonym named synObj1 in db1 database in dbo schema on sql2017a instance for Obj1 object in the same database.

Example: 3

PS C:\> New-DbaDbSynonym -SqlInstance sql2017a -Database db1 -Schema sch1 -Synonym synObj1 -BaseObject Obj1

Will create a new synonym named synObj1 within dbo schema in db1 database on sql2017a instance for Obj1 object in the same database.

Example: 4

PS C:\> New-DbaDbSynonym -SqlInstance sql2017a -Database db1 -Schema sch1 -Synonym synObj1 -BaseObject Obj1 -BaseSchema bSch2

Will create a new synonym named synObj1 within sch1 schema in db1 database on sql2017a instance for Obj1 object within bSch2 schema in the same database.

Example: 5

PS C:\> New-DbaDbSynonym -SqlInstance sql2017a -Database db1 -Schema sch1 -Synonym synObj1 -BaseObject Obj1 -BaseSchema bSch2 -BaseDatabase bDb3

Will create a new synonym named synObj1 within sch1 schema in db1 database on sql2017a instance for Obj1 object within bSch2 schema in bDb3 database.

Example: 6

PS C:\> New-DbaDbSynonym -SqlInstance sql2017a -Database db1 -Schema sch1 -Synonym synObj1 -BaseObject Obj1 -BaseSchema bSch2 -BaseDatabase bDb3 -BaseServer bSrv4

Will create a new synonym named synObj1 within sch1 schema in db1 database on sql2017a instance for Obj1 object within bSch2 schema in bDb3 database on bSrv4 linked server.

Example: 7

PS C:\> Get-DbaDatabase -SqlInstance sql2017a -ExcludeSystem | New-DbaDbSynonym -Synonym synObj1 -BaseObject Obj1

Will create a new synonym named synObj1 within dbo schema in all user databases on sql2017a instance for Obj1 object in the respective databases.

Required Parameters

-BaseObject

The name of the database object that the synonym will reference. Supports tables, views, stored procedures, functions, and other schema-scoped objects.
This is the actual object that users will access through the synonym name, enabling abstraction and simplified references.

Optional Parameters

-SqlInstance

The target SQL Server instance or 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 databases to create the synonym in. Accepts wildcards for pattern matching.
When omitted, synonyms will be created in all accessible databases on the instance.

-ExcludeDatabase

Excludes specific databases from synonym creation when processing multiple databases.
Useful when you want to create synonyms across most databases but skip system databases or specific user databases.

-Synonym

The name of the synonym to create. This becomes the alternate name that applications and users will reference.
Choose meaningful names that follow your organization's naming conventions and make object access more intuitive.

-Schema

The schema where the synonym will be created. Defaults to 'dbo' if not specified.
Consider using application-specific schemas to organize synonyms logically and control access through schema permissions.

-BaseServer

The linked server name when creating cross-server synonyms. Requires BaseDatabase and BaseSchema parameters.
Use this to create synonyms that reference objects on remote SQL Server instances through established linked server connections.

-BaseDatabase

The database containing the target object that the synonym will reference. Requires BaseSchema when specified.
Use this for cross-database synonyms or when creating synonyms on linked servers to reference objects in specific databases.

-BaseSchema

The schema containing the target object that the synonym will reference.
Required when BaseDatabase is specified, ensuring the synonym points to the correct object in complex multi-schema environments.

-InputObject

Accepts database objects piped from Get-DbaDatabase for creating synonyms across multiple databases.
Useful for batch operations when you need to create the same synonym in multiple databases selected by specific criteria.

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