Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Synonym Class

The Synonym object represents a SQL Server synonym.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Synonym sealed : public ScriptSchemaObjectBase, 
	ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, 
	IScriptable, IAlterable

The Synonym type exposes the following members.

  NameDescription
Public methodSynonym()Initializes a new instance of the Synonym class.
Public methodSynonym(Database, String)Initializes a new instance of the Synonym class on the specified database and with the specified name.
Public methodSynonym(Database, String, String)Initializes a new instance of the Synonym class on the specified database and with the specified name and schema.
Public methodSynonym(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.
Public methodSynonym(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
  NameDescription
Public propertyBaseDatabaseGets or sets the base database on which the base object resides.
Public propertyBaseObjectGets or sets the base object for which the synonym is defined.
Public propertyBaseSchemaGets or sets the schema of the base object.
Public propertyBaseServerGets or sets the instance of SQL Server on which the base object resides.
Public propertyBaseTypeSpecifies the type of the Synonym object.
Public propertyCreateDateGets the date and time when the synonym was created.
Public propertyDateLastModifiedGets the date and time when the synonym was last modified.
Public propertyEventsGets the events that are supported by the synonym.
Public propertyExtendedPropertiesRepresents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object.
Public propertyIDGets the ID value that uniquely identifies the synonym.
Public propertyIsSchemaOwnedGets a Boolean value that specifies whether the Synonym object is owned by a schema.
Public propertyNameGets or sets a String value that specifies the name of the synonym. (Overrides ScriptSchemaObjectBase::Name.)
Public propertyOwnerGets or sets the owner of the Synonym.
Public propertyParentGets the Database object that is the parent of the Synonym object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySchemaGets or sets a String value that specifies the name of the schema that contains the synonym. (Overrides ScriptSchemaObjectBase::Schema.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top
  NameDescription
Public methodAlterUpdates any Synonym object property changes on the instance of SQL Server.
Public methodCreateCreates a synonym on the instance of SQL Server as defined by the Synonym object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the synonym.
Public methodDeny(ObjectPermissionSet, array<String>)Denies the specified set of permissions for the specified grantees on the synonym.
Public methodDeny(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.
Public methodDeny(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.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the synonym from the instance of SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the synonym.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the synonym.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the synonym.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the synonym.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the synonym.
Public methodGrant(ObjectPermissionSet, array<String>)Grants the specified set of permissions to the specified grantees on the synonym.
Public methodGrant(ObjectPermissionSet, String, Boolean)Grants access to the specified permission to the grantee and the ability to grant access to other users on the synonym.
Public methodGrant(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.
Public methodGrant(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.
Public methodGrant(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.
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the synonym.
Public methodRevoke(ObjectPermissionSet, array<String>)Revokes a previously granted set of permissions from a list of grantees on the synonym.
Public methodRevoke(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.
Public methodRevoke(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.
Public methodRevoke(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.
Public methodRevoke(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.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the synonym.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the synonym as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top
  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top
  NameDescription
Explicit interface implemetationPrivate methodIAlienObject::DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetUrnGets 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.)
Explicit interface implemetationPrivate methodIAlienObject::ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider::GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode::IsDesignModeGets a Boolean value that specifies whether the synonym supports design mode.
Top

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

'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()
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.