Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

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 sealed class Synonym : ScriptSchemaObjectBase, ISfcSupportsDesignMode, 
	IObjectPermission, ICreatable, IDroppable, IExtendedProperties, 
	IScriptable, IAlterable

NameDescription
System_CAPS_pubmethodSynonym()

Initializes a new instance of the Synonym class.

System_CAPS_pubmethodSynonym(Database, String)

Initializes a new instance of the Synonym class on the specified database and with the specified name.

System_CAPS_pubmethodSynonym(Database, String, String)

Initializes a new instance of the Synonym class on the specified database and with the specified name and schema.

System_CAPS_pubmethodSynonym(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.

System_CAPS_pubmethodSynonym(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.

NameDescription
System_CAPS_pubpropertyBaseDatabase

Gets or sets the base database on which the base object resides.

System_CAPS_pubpropertyBaseObject

Gets or sets the base object for which the synonym is defined.

System_CAPS_pubpropertyBaseSchema

Gets or sets the schema of the base object.

System_CAPS_pubpropertyBaseServer

Gets or sets the instance of SQL Server on which the base object resides.

System_CAPS_pubpropertyBaseType

Specifies the type of the Synonym object.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the synonym was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the synonym was last modified.

System_CAPS_pubpropertyEvents

Gets the events that are supported by the synonym.

System_CAPS_pubpropertyExtendedProperties

Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the synonym.

System_CAPS_pubpropertyIsSchemaOwned

Gets a Boolean value that specifies whether the Synonym object is owned by a schema.

System_CAPS_pubpropertyName

Gets or sets a String value that specifies the name of the synonym.(Overrides ScriptSchemaObjectBase.Name.)

System_CAPS_pubpropertyOwner

Gets or sets the owner of the Synonym.

System_CAPS_pubpropertyParent

Gets the Database object that is the parent of the Synonym object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySchema

Gets or sets a String value that specifies the name of the schema that contains the synonym.(Overrides ScriptSchemaObjectBase.Schema.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any Synonym object property changes on the instance of SQL Server.

System_CAPS_pubmethodCreate()

Creates a synonym on the instance of SQL Server as defined by the Synonym object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the synonym.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the synonym.

System_CAPS_pubmethodDeny(ObjectPermissionSet, 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.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the synonym from the instance of SQL Server.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the synonym.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the synonym.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the synonym.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the synonym.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the synonym.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String, Boolean)

Grants access to the specified permission to the grantee and the ability to grant access to other users on the synonym.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the synonym.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the synonym.

System_CAPS_pubmethodGrant(ObjectPermissionSet, 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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the synonym.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions from a list of grantees on the synonym.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the synonym.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the synonym as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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

Legacy Code Example

Code snippet is not found. Confirm that the code snippet name 'SMO How to' is correct.

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

Return to top

Community Additions

Show:
© 2015 Microsoft