Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Synonym Members

The Synonym object represents a Microsoft SQL Server synonym.

The following tables list the members exposed by the Synonym type.

  Name Description
Synonym Overloaded. Initializes a new instance of the Synonym class.
Top
  Name Description
ms220507.protfield(en-US,SQL.90).gif m_ExtendedProperties  (inherited from SqlSmoObject )
Top
(see also Protected Properties )
  Name Description
ms220507.pubproperty(en-US,SQL.90).gif BaseDatabase Gets or sets the base database on which the base object resides.
ms220507.pubproperty(en-US,SQL.90).gif BaseObject Gets or sets the base object for which the synonym is defined.
ms220507.pubproperty(en-US,SQL.90).gif BaseSchema Gets or sets the schema of the base object.
ms220507.pubproperty(en-US,SQL.90).gif BaseServer Gets or sets the instance of Microsoft SQL Server on which the base object resides.
ms220507.pubproperty(en-US,SQL.90).gif CreateDate Gets the date and time when the synonym was created.
ms220507.pubproperty(en-US,SQL.90).gif DateLastModified Gets the date and time when the synonym was last modified.
ms220507.pubproperty(en-US,SQL.90).gif Events Gets the events that are supported by the synonym.
ms220507.pubproperty(en-US,SQL.90).gif ExtendedProperties Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object.
ms220507.pubproperty(en-US,SQL.90).gif ID Gets the ID value that uniquely identifies the synonym.
ms220507.pubproperty(en-US,SQL.90).gif Name  Gets or sets the name of the object. (inherited from NamedSmoObject)
ms220507.pubproperty(en-US,SQL.90).gif Parent Gets the Database object that is the parent of the Synonym object.
ms220507.pubproperty(en-US,SQL.90).gif Properties  Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject)
ms220507.pubproperty(en-US,SQL.90).gif Schema  Gets or sets the schema. (inherited from ScriptSchemaObjectBase)
ms220507.pubproperty(en-US,SQL.90).gif State  Gets the state of the referenced object. (inherited from SmoObjectBase)
ms220507.pubproperty(en-US,SQL.90).gif Urn  Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject)
ms220507.pubproperty(en-US,SQL.90).gif UserData  Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase)
Top
  Name Description
ms220507.protproperty(en-US,SQL.90).gif ExecuteForScalar  Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject)
ms220507.protproperty(en-US,SQL.90).gif ObjectInSpace  Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject)
ms220507.protproperty(en-US,SQL.90).gif PresetProperties  Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject)
ms220507.protproperty(en-US,SQL.90).gif ScalarResult  Gets the scalar result for the referenced object. (inherited from SqlSmoObject)
Top
(see also Protected Methods )
  Name Description
ms220507.pubmethod(en-US,SQL.90).gif Alter Updates any Synonym object property changes on the instance of Microsoft SQL Server.
ms220507.pubmethod(en-US,SQL.90).gif Create Creates a synonym on the instance of Microsoft SQL Server as defined by the Synonym object.
ms220507.pubmethod(en-US,SQL.90).gif Deny Overloaded. Denies the specified set of permissions for the specified grantees on the synonym.
ms220507.pubmethod(en-US,SQL.90).gif Drop Removes the synonym from the instance of Microsoft SQL Server.
ms220507.pubmethod(en-US,SQL.90).gif EnumObjectPermissions Overloaded. Enumerates a list of object permissions for the synonym.
ms220507.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms220507.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms220507.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms220507.pubmethod(en-US,SQL.90).gif Grant Overloaded. Grants the specified set of permissions to the specified grantees on the synonym.
ms220507.pubmethod(en-US,SQL.90).gif Initialize  Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject)
ms220507.pubmethod(en-US,SQL.90).gif ms220507.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms220507.pubmethod(en-US,SQL.90).gif Refresh  Refreshes the script name. (inherited from ScriptNameObjectBase)
ms220507.pubmethod(en-US,SQL.90).gif Revoke Overloaded. Revokes a previously granted set of permissions from a grantee or grantees on the synonym.
ms220507.pubmethod(en-US,SQL.90).gif Script Overloaded. Generates a Transact-SQL script that can be used to re-create the synonym.
ms220507.pubmethod(en-US,SQL.90).gif ToString  Returns a String that represents the referenced object. (inherited from SqlSmoObject)
Top
  Name Description
ms220507.protmethod(en-US,SQL.90).gif AlterImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif AlterImplFinish  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif AlterImplInit  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif AlterImplWorker  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif AppendCommaText  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif AppendWithCommaText  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif AppendWithOption  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif BindDefaultImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif BindRuleImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif CheckCollation  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif CheckObjectState  Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif CheckObjectStateImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif CheckTextCorectness  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif CheckTextModeSupport  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif CheckVersion80  Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif CheckVersion80SP3  Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif CheckVersion90  Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif CheckVersionBelow90  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif CleanObject  Cleans the referenced object. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-US,SQL.90).gif CreateImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif CreateImplFinish  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif CreateImplInit  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif DropImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif DropImplWorker  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms220507.protmethod(en-US,SQL.90).gif ForceTextModeOnTextBody  Enforces text mode on the text body. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-US,SQL.90).gif FormatSqlVariant  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GenerateDataSpaceScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetBindDefaultScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetBindRuleScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetBoolParameter  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetBraketNameForText  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif GetDateTimeParameter  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetDateTimeParameterAsInt  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetDBName  Gets the database name associated with the object. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif GetEnumParameter  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetFragOptionString  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetGuidParameter  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetIsTextDirty  Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-US,SQL.90).gif GetParameter  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetPropValue  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetPropValueOptional  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetPropValueOptionalAllowNull  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetRealValue  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetScriptIncludeExists  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif GetScriptingOptionsForCreate  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetServerName  Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif GetSqlServerVersionName  Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif GetStringParameter  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetTextBody  Overloaded. Returns the text body. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-US,SQL.90).gif GetTextForScript  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif GetTextHeader  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif GetTextMode  Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-US,SQL.90).gif GetTextProperty  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif GetTimeSpanParameterAsInt  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif GetUrnRecursive  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ImplInitialize  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ms220507.static(en-US,SQL.90).gif IsCollectionDirty  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif IsObjectDirty  Determines whether the referenced object is consistent with the stored object. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-US,SQL.90).gif IsObjectInitialized  Verifies whether the object has been initialized. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif IsObjectInSpace  Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms220507.protmethod(en-US,SQL.90).gif IsVersion80SP3  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif MarkDropped  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif MarkForDropImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )
ms220507.protmethod(en-US,SQL.90).gif PostAlter  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif PostCreate  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif PostDrop  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif RenameImpl  (inherited from NamedSmoObject )
ms220507.protmethod(en-US,SQL.90).gif RenameImplWorker  (inherited from NamedSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptAlter  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptAnsiQI  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif ScriptChangeOwner  (inherited from NamedSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptCreate  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptDdl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptDrop  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptImpl  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptImplWorker  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ScriptInformativeHeaders  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif ScriptRename  (inherited from NamedSmoObject )
ms220507.protmethod(en-US,SQL.90).gif SetCollectionTextMode  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif SetParentImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif SetTextBody  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif SetTextHeader  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif SetTextMode  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif SwitchTextMode  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif ThrowIfTextIsDirtyForAlter  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-US,SQL.90).gif ms220507.static(en-US,SQL.90).gif Trace  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif UnbindDefaultImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif UnbindRuleImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-US,SQL.90).gif ms220507.static(en-US,SQL.90).gif UpdateCollectionState2  (inherited from SqlSmoObject )
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.