Compartilhar via


Classe Synonym

The Synonym object represents a SQL Server synonym.

Hierarquia de herança

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 (em Microsoft.SqlServer.Smo.dll)

Sintaxe

'Declaração
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Synonym _
    Inherits ScriptSchemaObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IExtendedProperties, IScriptable, IAlterable
'Uso
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

O tipo Synonym expõe os membros a seguir.

Construtores

  Nome Descrição
Método público Synonym() Initializes a new instance of the Synonym class.
Método público Synonym(Database, String) Initializes a new instance of the Synonym class on the specified database and with the specified name.
Método público Synonym(Database, String, String) Initializes a new instance of the Synonym class on the specified database and with the specified name and schema.
Método público 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.
Método público 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.

Início

Propriedades

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

Início

Métodos

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

Início

Eventos

  Nome Descrição
Evento público PropertyChanged Represents the event that occurs when a property is changed. (Herdado de SqlSmoObject.)
Evento público PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetDomainRoot Returns the root of the domain. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetParent Gets the parent of this object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyType Gets the type of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasPropriedade privada ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that specifies whether the synonym supports design mode.

Início

Comentários

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

Exemplos

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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo

Outros recursos

Usando sinônimos

Usando sinônimos (Mecanismo de Banco de Dados)

CREATE SYNONYM (Transact-SQL)