Classe Synonym

Article
04/26/2013

The Synonym object represents a SQL Server synonym.

Hiérarchie d'héritage

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

Espace de noms : Microsoft.SqlServer.Management.Smo
Assembly : Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Synonym _
    Inherits ScriptSchemaObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IExtendedProperties, IScriptable, IAlterable
'Utilisation
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

Le type Synonym expose les membres suivants.

Constructeurs

	Nom	Description
	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.

Haut de la page

Propriétés

	Nom	Description
	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. (remplace 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. (hérité de SqlSmoObject.)
	Schema	Gets or sets a String value that specifies the name of the schema that contains the synonym. (remplace ScriptSchemaObjectBase.Schema.)
	State	Gets the state of the referenced object. (hérité de SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (hérité de SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (hérité de SmoObjectBase.)

Haut de la page

Méthodes

	Nom	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. (hérité de 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	(hérité de Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (hérité de SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (hérité de SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (hérité de SqlSmoObject.)
	GetHashCode	(hérité de Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetType	(hérité de 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. (hérité de SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (hérité de SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (hérité de SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (hérité de SqlSmoObject.)
	Refresh	Refreshes the script name. (hérité de 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. (hérité de SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (hérité de SqlSmoObject.)
	Validate	Validates the state of an object. (hérité de SmoObjectBase.)

Haut de la page

Événements

	Nom	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (hérité de SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

	Nom	Description
	IAlienObject.Discover	Discovers any dependencies. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (hérité de SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (hérité de SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (hérité de SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (hérité de SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (hérité de SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (hérité de SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (hérité de SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the synonym supports design mode.

Haut de la page

Notes

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

Exemples

'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()

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.