Welcome Sign in
SQL Server Developer Center
Click to Rate and Give Feedback
MSDN
MSDN Library
SQL Server
SQL Server 2008
Database Engine
Technical Reference
Synonym Class
 Synonym Members
Community Content
In this section
Statistics Annotations (0)
Other versions are also available for the following:
Synonym Members

The Synonym object represents a 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.100).gif m_ExtendedProperties  (inherited from SqlSmoObject )
Top
(see also Protected Properties )
  Name Description
ms220507.pubproperty(en-us,SQL.100).gif BaseDatabase Gets or sets the base database on which the base object resides.
ms220507.pubproperty(en-us,SQL.100).gif BaseObject Gets or sets the base object for which the synonym is defined.
ms220507.pubproperty(en-us,SQL.100).gif BaseSchema Gets or sets the schema of the base object.
ms220507.pubproperty(en-us,SQL.100).gif BaseServer Gets or sets the instance of SQL Server on which the base object resides.
ms220507.pubproperty(en-us,SQL.100).gif BaseType  
ms220507.pubproperty(en-us,SQL.100).gif CreateDate Gets the date and time when the synonym was created.
ms220507.pubproperty(en-us,SQL.100).gif DateLastModified Gets the date and time when the synonym was last modified.
ms220507.pubproperty(en-us,SQL.100).gif Events Gets the events that are supported by the synonym.
ms220507.pubproperty(en-us,SQL.100).gif ExtendedProperties Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object.
ms220507.pubproperty(en-us,SQL.100).gif ID Gets the ID value that uniquely identifies the synonym.
ms220507.pubproperty(en-us,SQL.100).gif IsSchemaOwned  
ms220507.pubproperty(en-us,SQL.100).gif Name  Gets or sets the name of the Schema Object Base. (inherited from ScriptSchemaObjectBase)
ms220507.pubproperty(en-us,SQL.100).gif Owner  
ms220507.pubproperty(en-us,SQL.100).gif Parent Gets the Database object that is the parent of the Synonym object.
ms220507.pubproperty(en-us,SQL.100).gif Properties  Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject)
ms220507.pubproperty(en-us,SQL.100).gif Schema  Gets or sets the schema. (inherited from ScriptSchemaObjectBase)
ms220507.pubproperty(en-us,SQL.100).gif State  Gets the state of the referenced object. (inherited from SmoObjectBase)
ms220507.pubproperty(en-us,SQL.100).gif Urn  Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject)
ms220507.pubproperty(en-us,SQL.100).gif UserData  Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase)
Top
  Name Description
ms220507.protproperty(en-us,SQL.100).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.100).gif IsTouched  Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (inherited from SqlSmoObject)
ms220507.protproperty(en-us,SQL.100).gif 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. (inherited from SqlSmoObject)
ms220507.protproperty(en-us,SQL.100).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.100).gif Alter Updates any Synonym object property changes on the instance of SQL Server.
ms220507.pubmethod(en-us,SQL.100).gif Create Creates a synonym on the instance of SQL Server as defined by the Synonym object.
ms220507.pubmethod(en-us,SQL.100).gif Deny Overloaded. Denies the specified set of permissions for the specified grantees on the synonym.
ms220507.pubmethod(en-us,SQL.100).gif Discover  (inherited from SqlSmoObject )
ms220507.pubmethod(en-us,SQL.100).gif Drop Removes the synonym from the instance of SQL Server.
ms220507.pubmethod(en-us,SQL.100).gif EnumObjectPermissions Overloaded. Enumerates a list of object permissions for the synonym.
ms220507.pubmethod(en-us,SQL.100).gif Equals  Overloaded. (inherited from Object )
ms220507.pubmethod(en-us,SQL.100).gif ms220507.static(en-us,SQL.100).gif GetChildType  (inherited from SqlSmoObject )
ms220507.pubmethod(en-us,SQL.100).gif GetHashCode  (inherited from Object )
ms220507.pubmethod(en-us,SQL.100).gif GetType  (inherited from Object )
ms220507.pubmethod(en-us,SQL.100).gif ms220507.static(en-us,SQL.100).gif GetTypeFromUrnSkeleton  (inherited from SqlSmoObject )
ms220507.pubmethod(en-us,SQL.100).gif Grant Overloaded. Grants the specified set of permissions to the specified grantees on the synonym.
ms220507.pubmethod(en-us,SQL.100).gif Initialize  Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject)
ms220507.pubmethod(en-us,SQL.100).gif ms220507.static(en-us,SQL.100).gif ReferenceEquals  (inherited from Object )
ms220507.pubmethod(en-us,SQL.100).gif Refresh  Refreshes the script name. (inherited from ScriptNameObjectBase)
ms220507.pubmethod(en-us,SQL.100).gif Revoke Overloaded. Revokes a previously granted set of permissions from a grantee or grantees on the synonym.
ms220507.pubmethod(en-us,SQL.100).gif Script Overloaded. Generates a Transact-SQL script that can be used to re-create the synonym.
ms220507.pubmethod(en-us,SQL.100).gif ToString  Returns a String that represents the referenced object. (inherited from SqlSmoObject)
ms220507.pubmethod(en-us,SQL.100).gif Validate  (inherited from SmoObjectBase )
Top
  Name Description
ms220507.protmethod(en-us,SQL.100).gif AddDatabaseContext  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif AlterImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif AlterImplFinish  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif AlterImplInit  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif AlterImplWorker  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif AppendCommaText  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif AppendWithCommaText  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif AppendWithOption  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif BindDefaultImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif BindRuleImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CheckCollation  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CheckObjectDirty  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif CheckObjectState  Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject)
ms220507.protmethod(en-us,SQL.100).gif CheckObjectStateImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CheckTextCorectness  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif CheckTextModeSupport  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif CheckVersion100  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CheckVersion80  Checks the validity of the object on SQL Server 2000. (inherited from SqlSmoObject)
ms220507.protmethod(en-us,SQL.100).gif CheckVersion80SP3  Checks the validity of the object on SQL Server 2000 SP3. (inherited from SqlSmoObject)
ms220507.protmethod(en-us,SQL.100).gif CheckVersion90  Check the validity of the object on SQL Server 2005. (inherited from SqlSmoObject)
ms220507.protmethod(en-us,SQL.100).gif CheckVersionBelow90  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CleanObject  Cleans the referenced object. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-us,SQL.100).gif CreateImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CreateImplFinish  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif CreateImplInit  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif DropImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif DropImplWorker  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif EnumScriptImpl  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif EnumScriptImplWorker  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif Finalize  (inherited from Object )
ms220507.protmethod(en-us,SQL.100).gif ForceTextModeOnTextBody  Enforces text mode on the text body. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-us,SQL.100).gif FormatSqlVariant  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GenerateDataSpaceFileStreamScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GenerateDataSpaceScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetBindDefaultScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetBindRuleScript  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetBoolParameter  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetBraketNameForText  (inherited from ScriptNameObjectBase )
ms220507.protmethod(en-us,SQL.100).gif GetDateTimeParameter  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetDateTimeParameterAsInt  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetDBName  Gets the database name that is associated with the object. (inherited from SqlSmoObject)
ms220507.protmethod(en-us,SQL.100).gif GetEnumParameter  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetFragOptionString  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetGuidParameter  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetIsTextDirty  Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase)
ms220507.protmethod(en-us,SQL.100).gif GetParameter  Overloaded. (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetPropValue  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetPropValueOptional  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetPropValueOptionalAllowNull  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetRealValue  (inherited from SqlSmoObject )
ms220507.protmethod(en-us,SQL.100).gif GetScriptIncludeExists  (inherited from