Synonym Class

The Synonym object represents a Microsoft SQL Server synonym.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public NotInheritable Class Synonym
    Inherits ScriptSchemaObjectBase
    Implements IObjectPermission, ICreatable, IDroppable, IExtendedProperties, _
    IScriptable, IAlterable

public sealed class Synonym : ScriptSchemaObjectBase, IObjectPermission, ICreatable, IDroppable, 
    IExtendedProperties, IScriptable, IAlterable

public ref class Synonym sealed : public ScriptSchemaObjectBase, IObjectPermission, ICreatable, IDroppable, 
    IExtendedProperties, IScriptable, IAlterable

public final class Synonym extends ScriptSchemaObjectBase implements IObjectPermission, ICreatable, 
    IDroppable, IExtendedProperties, IScriptable, IAlterable

public final class Synonym extends ScriptSchemaObjectBase implements IObjectPermission, ICreatable, 
    IDroppable, IExtendedProperties, IScriptable, IAlterable

Remarks

Updated text:

The Synonym object provides programmatic access to synonyms. Synonyms can be used to create an alternative name for any SQL Server object.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Inheritance Hierarchy

System.Object
   Microsoft.SqlServer.Management.Smo.SmoObjectBase
     Microsoft.SqlServer.Management.Smo.SqlSmoObject
       Microsoft.SqlServer.Management.Smo.NamedSmoObject
         Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
           Microsoft.SqlServer.Management.Smo.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.Synonym

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server()
'Reference the AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")
'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.
Dim syn As Synonym
syn = New Synonym(db, "Shop", "Sales")
'Specify the base object, which is the object on which the synonym is based.
syn.BaseDatabase = "AdventureWorks"
syn.BaseSchema = "Sales"
syn.BaseObject = "Store"
syn.BaseServer = srv.Name
'Create the synonym on the instance of SQL Server.
syn.Create()

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Synonym Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Create a Synonym in Visual Basic .NET
Using Synonyms (Database Engine)
Using Synonyms
CREATE SYNONYM (Transact-SQL)

Change History