| Author | Mikey Bronowski (@MikeyBronowski), bronowski.it |
| Availability | Windows, Linux, macOS |
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.
Create new synonym for each database(s) / instance(s) of SQL Server.
The New-DbaDbSynonym creates new synonym on database(s) / instance(s) of SQL Server.
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>]
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.
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.
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.
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.
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.
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.
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.
The object name. Can be table, view, stored procedure, function, etc.
| Alias | |
| Required | True |
| Pipeline | false |
| Default Value |
The target SQL Server instance or instances.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
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 |
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 |
The database(s) to exclude - this list is auto-populated from the server
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
The synonym to create.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
The schema of the synonym. If not specified will assume the default dbo.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | dbo |
The linked server name. If specified then BaseDatabase and BaseSchema are required.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
The object parent database name. If specified then BaseSchema is required.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
The object parent schema name.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Enables piped input from Get-DbaDatabase
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |
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 |
Shows what would happen if the command were to run. No actions are actually performed.
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |
Prompts you for confirmation before executing any changing operations within the command.
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |