• Article

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
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,  _
    GetType(Synonym), SfcObjectFlags.Design)> _
Public ReadOnly Property Synonyms As SynonymCollection
    Get
'Usage
Dim instance As Database
Dim value As SynonymCollection

value = instance.Synonyms

[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(Synonym), SfcObjectFlags.Design)]
public SynonymCollection Synonyms { get; }

[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny, 
    typeof(Synonym), SfcObjectFlags::Design)]
public:
property SynonymCollection^ Synonyms {
    SynonymCollection^ get ();
}

[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(Synonym), SfcObjectFlags.Design)>]
member Synonyms : SynonymCollection

function get Synonyms () : SynonymCollection

Property Value

Type: Microsoft.SqlServer.Management.Smo.SynonymCollection
A SynonymCollection object that represents all the synonyms defined on the database.

Remarks

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.

Examples

VB

Dim srv As Server
        srv = New Server

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

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

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")

Foreach ($sy in $db.Synonyms)
{
   Write-Host $sy.Name
}