Synonym 类
The Synonym object represents a SQL Server synonym.
继承层次结构
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
命名空间： Microsoft.SqlServer.Management.Smo
程序集： Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）
语法
声明
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Synonym _
Inherits ScriptSchemaObjectBase _
Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, _
IExtendedProperties, IScriptable, IAlterable
用法
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
Synonym 类型公开以下成员。
构造函数
| 名称 | 说明 | |
|---|---|---|
.gif "公共方法") |
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. |
页首
属性
| 名称 | 说明 | |
|---|---|---|
.gif "公共属性") |
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. （覆盖 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. （从 SqlSmoObject 继承。） |
|
Schema | Gets or sets a String value that specifies the name of the schema that contains the synonym. （覆盖 ScriptSchemaObjectBase.Schema。） |
|
State | Gets the state of the referenced object. （从 SmoObjectBase 继承。） |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. （从 SqlSmoObject 继承。） |
|
UserData | Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。） |
页首
方法
| 名称 | 说明 | |
|---|---|---|
|
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. （从 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 | （从 Object 继承。） |
.gif "受保护方法") |
FormatSqlVariant | Formats an object as SqlVariant type. （从 SqlSmoObject 继承。） |
|
GetContextDB | Gets the context database that is associated with this object. （从 SqlSmoObject 继承。） |
|
GetDBName | Gets the database name that is associated with the object. （从 SqlSmoObject 继承。） |
|
GetHashCode | （从 Object 继承。） |
|
GetPropValue | Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。） |
|
GetPropValueOptional | Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。） |
|
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。） |
|
GetServerObject | Gets the server of the SqlSmoObject object. （从 SqlSmoObject 继承。） |
|
GetType | （从 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. （从 SqlSmoObject 继承。） |
|
Initialize(Boolean) | Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。） |
|
IsObjectInitialized | Verifies whether the object has been initialized. （从 SqlSmoObject 继承。） |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. （从 SqlSmoObject 继承。） |
|
Refresh | Refreshes the script name. （从 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. （从 SqlSmoObject 继承。） |
|
ToString | Returns a String that represents the referenced object. （从 SqlSmoObject 继承。） |
|
Validate | Validates the state of an object. （从 SmoObjectBase 继承。） |
页首
事件
| 名称 | 说明 | |
|---|---|---|
.gif "公共事件") |
PropertyChanged | Represents the event that occurs when a property is changed. （从 SqlSmoObject 继承。） |
|
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. （从 SqlSmoObject 继承。） |
页首
显式接口实现
| 名称 | 说明 | |
|---|---|---|
.gif "显式接口实现") .gif "私有方法") |
IAlienObject.Discover | Discovers any dependencies. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
|
IAlienObject.GetDomainRoot | Returns the root of the domain. （从 SqlSmoObject 继承。） |
|
IAlienObject.GetParent | Gets the parent of this object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
|
IAlienObject.GetPropertyType | Gets the type of the specified property. （从 SqlSmoObject 继承。） |
|
IAlienObject.GetPropertyValue | Gets the value of the specified property. （从 SqlSmoObject 继承。） |
|
IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
|
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. （从 SqlSmoObject 继承。） |
|
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. （从 SqlSmoObject 继承。） |
|
IAlienObject.SetPropertyValue | Sets the property value. （从 SqlSmoObject 继承。） |
|
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. （从 SqlSmoObject 继承。） |
.gif "私有属性") |
ISfcSupportsDesignMode.IsDesignMode | Gets a Boolean value that specifies whether the synonym supports design mode. |
页首
注释
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()
线程安全
此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。
请参阅
参考
Microsoft.SqlServer.Management.Smo 命名空间