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 中）

语法

声明
<StateChangeEventAttribute("CREATE_SYNONYM", "SYNONYM")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
<StateChangeEventAttribute("RENAME", "SYNONYM")> _
Public NotInheritable Class Synonym _
    Inherits ScriptSchemaObjectBase _
    Implements IObjectPermission, ICreatable, IDroppable, IExtendedProperties,  _
    IScriptable, IAlterable
用法
Dim instance As Synonym

[StateChangeEventAttribute("CREATE_SYNONYM", "SYNONYM")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
[StateChangeEventAttribute("RENAME", "SYNONYM")]
public sealed class Synonym : ScriptSchemaObjectBase, 
    IObjectPermission, ICreatable, IDroppable, IExtendedProperties, IScriptable, 
    IAlterable

[StateChangeEventAttribute(L"CREATE_SYNONYM", L"SYNONYM")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
[StateChangeEventAttribute(L"RENAME", L"SYNONYM")]
public ref class Synonym sealed : public ScriptSchemaObjectBase, 
    IObjectPermission, ICreatable, IDroppable, IExtendedProperties, IScriptable, 
    IAlterable

[<SealedAttribute>]
[<StateChangeEventAttribute("CREATE_SYNONYM", "SYNONYM")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("RENAME", "SYNONYM")>]
type Synonym =  
    class
        inherit ScriptSchemaObjectBase
        interface IObjectPermission
        interface ICreatable
        interface IDroppable
        interface IExtendedProperties
        interface IScriptable
        interface IAlterable
    end

public final class Synonym extends ScriptSchemaObjectBase implements IObjectPermission, ICreatable, IDroppable, IExtendedProperties, IScriptable, IAlterable

Synonym 类型公开以下成员。

构造函数

	名称	说明
	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.

页首

属性

	名称	说明
	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
	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.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. （从 SqlSmoObject 继承。）
	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
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. （从 SqlSmoObject 继承。）
	Name	Gets or sets the name of the Schema Object Base. （从 ScriptSchemaObjectBase 继承。）
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	Owner
	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 继承。）
	ScalarResult	Gets the scalar result for the referenced object. （从 SqlSmoObject 继承。）
	Schema	Gets or sets the schema. （从 ScriptSchemaObjectBase 继承。）
	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 继承。）

页首

方法

	名称	说明
	AddDatabaseContext	（从 SqlSmoObject 继承。）
	Alter	Updates any Synonym object property changes on the instance of SQL Server.
	AlterImpl	（从 SqlSmoObject 继承。）
	AlterImplFinish	（从 SqlSmoObject 继承。）
	AlterImplInit	（从 SqlSmoObject 继承。）
	AlterImplWorker	（从 SqlSmoObject 继承。）
	AppendCommaText	（从 ScriptNameObjectBase 继承。）
	AppendWithCommaText	（从 ScriptNameObjectBase 继承。）
	AppendWithOption	（从 ScriptNameObjectBase 继承。）
	BindDefaultImpl	（从 SqlSmoObject 继承。）
	BindRuleImpl	（从 SqlSmoObject 继承。）
	CheckCollation	（从 SqlSmoObject 继承。）
	CheckObjectDirty	（从 ScriptNameObjectBase 继承。）
	CheckObjectState() () () ()	Validates the state of the referenced object. （从 SqlSmoObject 继承。）
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. （从 SqlSmoObject 继承。）
	CheckObjectStateImpl	（从 SqlSmoObject 继承。）
	CheckTextCorectness	（从 ScriptNameObjectBase 继承。）
	CheckTextModeSupport	（从 ScriptNameObjectBase 继承。）
	CheckVersion100	（从 SqlSmoObject 继承。）
	CheckVersion80	Checks the validity of the object on SQL Server 2000. （从 SqlSmoObject 继承。）
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. （从 SqlSmoObject 继承。）
	CheckVersion90	Check the validity of the object on SQL Server 2005. （从 SqlSmoObject 继承。）
	CheckVersionBelow90	（从 SqlSmoObject 继承。）
	CleanObject	Cleans the referenced object. （从 ScriptNameObjectBase 继承。）
	Create	Creates a synonym on the instance of SQL Server as defined by the Synonym object.
	CreateImpl	（从 SqlSmoObject 继承。）
	CreateImplFinish	（从 SqlSmoObject 继承。）
	CreateImplInit	（从 SqlSmoObject 继承。）
	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	（从 SqlSmoObject 继承。）
	Drop	Removes the synonym from the instance of SQL Server.
	DropImpl	（从 SqlSmoObject 继承。）
	DropImplWorker	（从 SqlSmoObject 继承。）
	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.
	EnumScriptImpl	（从 SqlSmoObject 继承。）
	EnumScriptImplWorker	（从 SqlSmoObject 继承。）
	Equals	（从 Object 继承。）
	Finalize	（从 Object 继承。）
	ForceTextModeOnTextBody	Enforces text mode on the text body. （从 ScriptNameObjectBase 继承。）
	FormatSqlVariant	（从 SqlSmoObject 继承。）
	GenerateDataSpaceFileStreamScript	（从 SqlSmoObject 继承。）
	GenerateDataSpaceScript	（从 SqlSmoObject 继承。）
	GetBindDefaultScript	（从 SqlSmoObject 继承。）
	GetBindRuleScript	（从 SqlSmoObject 继承。）
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetBraketNameForText	（从 ScriptNameObjectBase 继承。）
	GetDateTimeParameter	（从 SqlSmoObject 继承。）
	GetDateTimeParameterAsInt	（从 SqlSmoObject 继承。）
	GetDBName	Gets the database name that is associated with the object. （从 SqlSmoObject 继承。）
	GetEnumParameter	（从 SqlSmoObject 继承。）
	GetFragOptionString	（从 SqlSmoObject 继承。）
	GetGuidParameter	（从 SqlSmoObject 继承。）
	GetHashCode	（从 Object 继承。）
	GetIsTextDirty	Determines whether the text value is consistent with stored value. （从 ScriptNameObjectBase 继承。）
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetPropValue	（从 SqlSmoObject 继承。）
	GetPropValueOptional	（从 SqlSmoObject 继承。）
	GetPropValueOptionalAllowNull	（从 SqlSmoObject 继承。）
	GetRealValue	（从 SqlSmoObject 继承。）
	GetScriptIncludeExists	（从 ScriptNameObjectBase 继承。）
	GetScriptingOptionsForCreate	（从 SqlSmoObject 继承。）
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetServerObject	（从 SqlSmoObject 继承。）
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetTextBody() () () ()	Returns the text body. （从 ScriptNameObjectBase 继承。）
	GetTextBody(Boolean)	Returns the text body. （从 ScriptNameObjectBase 继承。）
	GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [])	Gets the text for scripting. （从 ScriptNameObjectBase 继承。）
	GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [], Boolean)	（从 ScriptNameObjectBase 继承。）
	GetTextHeader	Returns the text header. （从 ScriptNameObjectBase 继承。）
	GetTextMode	Determines whether the script name is using text mode. （从 ScriptNameObjectBase 继承。）
	GetTextProperty(String)	（从 ScriptNameObjectBase 继承。）
	GetTextProperty(String, ScriptingOptions)	（从 ScriptNameObjectBase 继承。）
	GetTimeSpanParameterAsInt	（从 SqlSmoObject 继承。）
	GetType	（从 Object 继承。）
	GetUrnRecursive(StringBuilder)	（从 SqlSmoObject 继承。）
	GetUrnRecursive(StringBuilder, UrnIdOption)	（从 SqlSmoObject 继承。）
	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.
	ImplInitialize	（从 SqlSmoObject 继承。）
	Initialize() () () ()	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. （从 ScriptNameObjectBase 继承。）
	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 继承。）
	IsVersion80SP3	（从 SqlSmoObject 继承。）
	MarkDropped	（从 SqlSmoObject 继承。）
	MarkForDropImpl	（从 SqlSmoObject 继承。）
	MemberwiseClone	（从 Object 继承。）
	PostAlter	（从 SqlSmoObject 继承。）
	PostCreate	（从 SqlSmoObject 继承。）
	PostDrop	（从 SqlSmoObject 继承。）
	Refresh	Refreshes the script name. （从 ScriptNameObjectBase 继承。）
	RenameImpl	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	RenameImplWorker	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	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.
	ScriptAlter	（从 SqlSmoObject 继承。）
	ScriptAnsiQI	（从 ScriptNameObjectBase 继承。）
	ScriptChangeOwner	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	ScriptCreate	（从 SqlSmoObject 继承。）
	ScriptDdl	（从 SqlSmoObject 继承。）
	ScriptDrop	（从 SqlSmoObject 继承。）
	ScriptImpl() () () ()	（从 SqlSmoObject 继承。）
	ScriptImpl(ScriptingOptions)	（从 SqlSmoObject 继承。）
	ScriptImplWorker	（从 SqlSmoObject 继承。）
	ScriptInformativeHeaders	（从 ScriptNameObjectBase 继承。）
	ScriptRename	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	SetCollectionTextMode	Sets the collection text mode. （从 ScriptNameObjectBase 继承。）
	SetParentImpl	（从 SqlSmoObject 继承。）
	SetTextBody	Specifies the text body. （从 ScriptNameObjectBase 继承。）
	SetTextHeader	Specifies the text header. （从 ScriptNameObjectBase 继承。）
	SetTextMode	Specifies the text mode. （从 ScriptNameObjectBase 继承。）
	SwitchTextMode	Switches the text mode. （从 ScriptNameObjectBase 继承。）
	ThrowIfTextIsDirtyForAlter	（从 ScriptNameObjectBase 继承。）
	ToString	Returns a String that represents the referenced object. （从 SqlSmoObject 继承。）
	TouchImpl	（从 SqlSmoObject 继承。）
	UnbindDefaultImpl	（从 SqlSmoObject 继承。）
	UnbindRuleImpl	（从 SqlSmoObject 继承。）
	Validate	（从 SmoObjectBase 继承。）

页首

事件

	名称	说明
	PropertyChanged	（从 SqlSmoObject 继承。）
	PropertyMetadataChanged	（从 SqlSmoObject 继承。）

页首

字段

	名称	说明
	m_ExtendedProperties	（从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObjectDiscover	（从 SqlSmoObject 继承。）
	IAlienObjectGetParent	（从 SqlSmoObject 继承。）
	IAlienObjectGetProperty	（从 SqlSmoObject 继承。）
	ISfcPropertyProviderGetPropertySet	（从 SqlSmoObject 继承。）
	IAlienObjectGetUrn	（从 SqlSmoObject 继承。）
	IAlienObjectResolve	（从 SqlSmoObject 继承。）
	IAlienObjectSetProperty	（从 SqlSmoObject 继承。）

页首

注释

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 AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")
'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 = "AdventureWorks"
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 命名空间

其他资源

使用同义词

使用同义词（数据库引擎）

CREATE SYNONYM (Transact-SQL)