using-synonyms.md

title	Using Synonyms | Microsoft Docs
ms.custom
ms.date	08/06/2017
ms.prod	sql-server-2016
ms.reviewer
ms.suite
ms.technology	docset-sql-devref
ms.tgt_pltfrm
ms.topic	reference
helpviewer_keywords	synonyms [SMO]
ms.assetid	db0a9022-9549-43e5-b6b3-deb236f05fb8
caps.latest.revision	49
author	JennieHubbard
ms.author	jhubbard
manager	jhubbard

Using Synonyms

A synonym is an alternative name for a schema-scoped object. In SMO, synonyms are represented by the xref:Microsoft.SqlServer.Management.Smo.Synonym object. The xref:Microsoft.SqlServer.Management.Smo.Synonym object is a child of the xref:Microsoft.SqlServer.Management.Smo.Database object. This means that synonyms are valid only within the scope of the database in which they are defined. However, the synonym can refer to objects on another database, or on a remote instance of [!INCLUDEssNoVersion].

The object that is given an alternative name is known as the base object. The name property of the xref:Microsoft.SqlServer.Management.Smo.Synonym object is the alternative name given to the base object.

Example

For the following code examples, you will have to select the programming environment, programming template and the programming language to create your application. For more information, see Create a Visual C# SMO Project in Visual Studio .NET.

Creating a Synonym in Visual C#

The code example shows how to create a synonym or an alternate name for a schema scoped object. Client applications can use a single reference for the base object via a synonym instead of using a multiple part name to reference the base object.

{  
            //Connect to the local, default instance of SQL Server.   
            Server srv = new Server();  
  
            //Reference the AdventureWorks2012 database.   
            Database db = srv.Databases["AdventureWorks2012"];  
  
            //Define a Synonym object variable by supplying the   
            //parent database, name, and schema arguments in the constructor.   
            //The name is also a synonym of the name of the base object.   
            Synonym syn = new Synonym(db, "Shop", "Sales");  
  
            //Specify the base object, which is the object on which   
            //the synonym is based.   
            syn.BaseDatabase = "AdventureWorks2012";  
            syn.BaseSchema = "Sales";  
            syn.BaseObject = "Store";  
            syn.BaseServer = srv.Name;  
  
            //Create the synonym on the instance of SQL Server.   
            syn.Create();  
        }  

Creating a Synonym in PowerShell

The code example shows how to create a synonym or an alternate name for a schema scoped object. Client applications can use a single reference for the base object via a synonym instead of using a multiple part name to reference the base object.

#Get a server object which corresponds to the default instance  
$srv = New-Object -TypeName Microsoft.SqlServer.Management.SMO.Server  
  
#And the database object corresponding to Adventureworks  
$db = $srv.Databases["AdventureWorks2012"]  
  
$syn = New-Object -TypeName Microsoft.SqlServer.Management.SMO.Synonym `  
-argumentlist $db, "Shop", "Sales"  
  
#Specify the base object, which is the object on which the synonym is based.  
$syn.BaseDatabase = "AdventureWorks2012"  
$syn.BaseSchema = "Sales"  
$syn.BaseObject = "Store"  
$syn.BaseServer = $srv.Name  
  
#Create the synonym on the instance of SQL Server.  
$syn.Create()  

See Also

CREATE SYNONYM (Transact-SQL)