Synonym Class
The Synonym object represents a SQL Server synonym.
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
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Synonym _
Inherits ScriptSchemaObjectBase _
Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, _
IExtendedProperties, IScriptable, IAlterable
'Usage
Dim instance As Synonym
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Synonym : ScriptSchemaObjectBase,
ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties,
IScriptable, IAlterable
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Synonym sealed : public ScriptSchemaObjectBase,
ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties,
IScriptable, IAlterable
[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Synonym =
class
inherit ScriptSchemaObjectBase
interface ISfcSupportsDesignMode
interface IObjectPermission
interface ICreatable
interface IDroppable
interface IExtendedProperties
interface IScriptable
interface IAlterable
end
public final class Synonym extends ScriptSchemaObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, IScriptable, IAlterable
The Synonym type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Synonym() | Initializes a new instance of the Synonym class. |
|
Synonym(Database, String) | Initializes a new instance of the Synonym class on the specified database and with the specified name. |
|
Synonym(Database, String, String) | Initializes a new instance of the Synonym class on the specified database and with the specified name and schema. |
|
Synonym(Database, String, String, String, String, String) | Initializes a new instance of the Synonym class on the specified database and with the specified name, and base object. |
|
Synonym(Database, String, String, String, String, String, String) | Initializes a new instance of the Synonym class on the specified database and with the specified name, schema, and base object. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BaseDatabase | Gets or sets the base database on which the base object resides. |
|
BaseObject | Gets or sets the base object for which the synonym is defined. |
|
BaseSchema | Gets or sets the schema of the base object. |
|
BaseServer | Gets or sets the instance of SQL Server on which the base object resides. |
|
BaseType | Specifies the type of the Synonym object. |
|
CreateDate | Gets the date and time when the synonym was created. |
|
DateLastModified | Gets the date and time when the synonym was last modified. |
|
Events | Gets the events that are supported by the synonym. |
|
ExtendedProperties | Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object. |
|
ID | Gets the ID value that uniquely identifies the synonym. |
|
IsSchemaOwned | Gets a Boolean value that specifies whether the Synonym object is owned by a schema. |
|
Name | Gets or sets a String value that specifies the name of the synonym. (Overrides ScriptSchemaObjectBase.Name.) |
|
Owner | Gets or sets the owner of the Synonym. |
|
Parent | Gets the Database object that is the parent of the Synonym object. |
|
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
|
Schema | Gets or sets a String value that specifies the name of the schema that contains the synonym. (Overrides ScriptSchemaObjectBase.Schema.) |
|
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Alter | Updates any Synonym object property changes on the instance of SQL Server. |
|
Create | Creates a synonym on the instance of SQL Server as defined by the Synonym object. |
|
Deny(ObjectPermissionSet, String) | Denies the specified set of permissions for the specified grantee on the synonym. |
|
Deny(ObjectPermissionSet, array<String[]) | Denies the specified set of permissions for the specified grantees on the synonym. |
|
Deny(ObjectPermissionSet, String, Boolean) | Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the synonym. |
|
Deny(ObjectPermissionSet, array<String[], Boolean) | Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the synonym. |
|
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
|
Drop | Removes the synonym from the instance of SQL Server. |
|
EnumObjectPermissions() | Enumerates a list of object permissions for the synonym. |
|
EnumObjectPermissions(String) | Enumerates a list of object permissions for a specified grantee on the synonym. |
|
EnumObjectPermissions(ObjectPermissionSet) | Enumerates a list of object permissions for a specified permission on the synonym. |
|
EnumObjectPermissions(String, ObjectPermissionSet) | Enumerates a list of object permissions for a specified grantee and a specified permission on the synonym. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) |
|
GetContextDB | Gets the context database that is associated with this object. (Inherited from SqlSmoObject.) |
|
GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetType | (Inherited from Object.) |
|
Grant(ObjectPermissionSet, String) | Grants the specified set of permissions to the specified grantee on the synonym. |
|
Grant(ObjectPermissionSet, array<String[]) | Grants the specified set of permissions to the specified grantees on the synonym. |
|
Grant(ObjectPermissionSet, String, Boolean) | Grants access to the specified permission to the grantee and the ability to grant access to other users on the synonym. |
|
Grant(ObjectPermissionSet, array<String[], Boolean) | Grants access to the specified permission to the grantees and the ability to grant access to other users on the synonym. |
|
Grant(ObjectPermissionSet, String, Boolean, String) | Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the synonym under an assumed role. |
|
Grant(ObjectPermissionSet, array<String[], Boolean, String) | Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the synonym under an assumed role. |
|
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
|
Refresh | Refreshes the script name. (Inherited from ScriptNameObjectBase.) |
|
Revoke(ObjectPermissionSet, String) | Revokes a previously granted set of permissions from a grantee on the synonym. |
|
Revoke(ObjectPermissionSet, array<String[]) | Revokes a previously granted set of permissions from a list of grantees on the synonym. |
|
Revoke(ObjectPermissionSet, String, Boolean, Boolean) | Revokes previously granted permissions from a grantee on the synonym and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role. |
|
Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) | Revokes previously granted permissions from grantees on the synonym and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role. |
|
Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) | Revokes previously granted permissions from a grantee on the synonym and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role. |
|
Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) | Revokes previously granted permissions from grantees on the synonym and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role. |
|
Script() | Generates a Transact-SQL script that can be used to re-create the synonym. |
|
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the synonym as specified by the script options. |
|
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
|
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
|
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) |
|
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetParent | Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.) |
|
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) |
|
IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) |
|
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.) |
.gif "Private property") |
ISfcSupportsDesignMode.IsDesignMode | Gets a Boolean value that specifies whether the synonym supports design mode. |
Top
Remarks
The Synonym object provides programmatic access to synonyms. Synonyms can be used to create an alternative name for any SQL Server object.
Examples
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server()
'Reference the AdventureWorks2012 2008R2 database.
Dim db As 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.
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 = "AdventureWorks2012"
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 Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace