Database.Synonyms Property

Represents a collection of Synonym objects. Each Synonym object represents a synonym defined on the database.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public ReadOnly Property Synonyms As SynonymCollection
public SynonymCollection Synonyms { get; }
public:
property SynonymCollection^ Synonyms {
    SynonymCollection^ get ();
}
/** @property */
public SynonymCollection get_Synonyms ()
public function get Synonyms () : SynonymCollection

Property Value

A SynonymCollection object that represents all the synonyms defined on the database.

Remarks

Updated text:17 July 2006

Specific synonyms can be referenced by using this collection by specifying the name of the synonym. To add a new synonym to the collection, call the synonym constructor, Synonym.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

Dim srv As Server
        srv = New Server

'Reference the AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")

'Display all the synonyms in the database.
Dim sy As Synonym
For Each sy In db.Synonyms
   Console.WriteLine(sy.Name)
Next

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Database Class
Database Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Create, Alter, and Remove a Database in Visual Basic .NET
Using Synonyms
Creating, Altering, and Removing Databases
CREATE DATABASE (Transact-SQL)

Change History

Release

History

17 July 2006

Changed content:
  • Added text to the Remarks section.

  • Added code to the Example section.