Synonym-Klasse

The Synonym object represents a SQL Server synonym.

Vererbungshierarchie

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

Der Synonym-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode Synonym() Initializes a new instance of the Synonym class.
Öffentliche Methode Synonym(Database, String) Initializes a new instance of the Synonym class on the specified database and with the specified name.
Öffentliche Methode Synonym(Database, String, String) Initializes a new instance of the Synonym class on the specified database and with the specified name and schema.
Öffentliche Methode 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.
Öffentliche Methode 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.

Zum Anfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft BaseDatabase Gets or sets the base database on which the base object resides.
Öffentliche Eigenschaft BaseObject Gets or sets the base object for which the synonym is defined.
Öffentliche Eigenschaft BaseSchema Gets or sets the schema of the base object.
Öffentliche Eigenschaft BaseServer Gets or sets the instance of SQL Server on which the base object resides.
Öffentliche Eigenschaft BaseType Specifies the type of the Synonym object.
Öffentliche Eigenschaft CreateDate Gets the date and time when the synonym was created.
Öffentliche Eigenschaft DateLastModified Gets the date and time when the synonym was last modified.
Öffentliche Eigenschaft Events Gets the events that are supported by the synonym.
Öffentliche Eigenschaft ExtendedProperties Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object.
Öffentliche Eigenschaft ID Gets the ID value that uniquely identifies the synonym.
Öffentliche Eigenschaft IsSchemaOwned Gets a Boolean value that specifies whether the Synonym object is owned by a schema.
Öffentliche Eigenschaft Name Gets or sets a String value that specifies the name of the synonym. (Überschreibt ScriptSchemaObjectBase.Name.)
Öffentliche Eigenschaft Owner Gets or sets the owner of the Synonym.
Öffentliche Eigenschaft Parent Gets the Database object that is the parent of the Synonym object.
Öffentliche Eigenschaft Properties Gets a collection of Property objects that represent the object properties. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft Schema Gets or sets a String value that specifies the name of the schema that contains the synonym. (Überschreibt ScriptSchemaObjectBase.Schema.)
Öffentliche Eigenschaft State Gets the state of the referenced object. (Geerbt von SmoObjectBase.)
Öffentliche Eigenschaft Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft UserData Gets or sets user-defined data associated with the referenced object. (Geerbt von SmoObjectBase.)

Zum Anfang

Methoden

  Name Beschreibung
Öffentliche Methode Alter Updates any Synonym object property changes on the instance of SQL Server.
Öffentliche Methode Create Creates a synonym on the instance of SQL Server as defined by the Synonym object.
Öffentliche Methode Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the synonym.
Öffentliche Methode Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the synonym.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode Discover Discovers a list of type Object. (Geerbt von SqlSmoObject.)
Öffentliche Methode Drop Removes the synonym from the instance of SQL Server.
Öffentliche Methode EnumObjectPermissions() Enumerates a list of object permissions for the synonym.
Öffentliche Methode EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the synonym.
Öffentliche Methode EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the synonym.
Öffentliche Methode EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the synonym.
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode FormatSqlVariant Formats an object as SqlVariant type. (Geerbt von SqlSmoObject.)
Geschützte Methode GetContextDB Gets the context database that is associated with this object. (Geerbt von SqlSmoObject.)
Geschützte Methode GetDBName Gets the database name that is associated with the object. (Geerbt von SqlSmoObject.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Geschützte Methode GetPropValue Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
Geschützte Methode GetPropValueOptional Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
Geschützte Methode GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
Geschützte Methode GetServerObject Gets the server of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
Öffentliche Methode GetType (Geerbt von Object.)
Öffentliche Methode Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the synonym.
Öffentliche Methode Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the synonym.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode Initialize() Initializes the object and forces the properties be loaded. (Geerbt von SqlSmoObject.)
Öffentliche Methode Initialize(Boolean) Initializes the object and forces the properties be loaded. (Geerbt von SqlSmoObject.)
Geschützte Methode IsObjectInitialized Verifies whether the object has been initialized. (Geerbt von SqlSmoObject.)
Geschützte Methode IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Geerbt von SqlSmoObject.)
Öffentliche Methode Refresh Refreshes the script name. (Geerbt von ScriptNameObjectBase.)
Öffentliche Methode Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the synonym.
Öffentliche Methode Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the synonym.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode Script() Generates a Transact-SQL script that can be used to re-create the synonym.
Öffentliche Methode Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the synonym as specified by the script options.
Geschützte Methode SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Geerbt von SqlSmoObject.)
Öffentliche Methode ToString Returns a String that represents the referenced object. (Geerbt von SqlSmoObject.)
Öffentliche Methode Validate Validates the state of an object. (Geerbt von SmoObjectBase.)

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis PropertyChanged Represents the event that occurs when a property is changed. (Geerbt von SqlSmoObject.)
Öffentliches Ereignis PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Geerbt von SqlSmoObject.)

Zum Anfang

Explizite Schnittstellenimplementierungen

  Name Beschreibung
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.Discover Discovers any dependencies. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.GetDomainRoot Returns the root of the domain. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.GetParent Gets the parent of this object. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.GetPropertyType Gets the type of the specified property. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.GetPropertyValue Gets the value of the specified property. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject.SetPropertyValue Sets the property value. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Eigenschaft ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that specifies whether the synonym supports design mode.

Zum Anfang

Hinweise

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

Beispiele

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

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Management.Smo-Namespace

Andere Ressourcen

Verwenden von Synonymen

Verwenden von Synonymen (Datenbankmodul)

CREATE SYNONYM (Transact-SQL)