ForeignKey Class (Microsoft.SqlServer.Management.Smo)

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

Other versions are also available for the following:

SQL Server 2005

ForeignKey Class

The ForeignKey object represents a SQL Server foreign key.

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

Syntax

VisualBasicDeclaration

Public NotInheritable Class ForeignKey
    Inherits ScriptNameObjectBase
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable, _
    IRenamable, IExtendedProperties, IScriptable

CSharp

public sealed class ForeignKey : ScriptNameObjectBase, ICreatable, IDroppable, IMarkForDrop, 
    IAlterable, IRenamable, IExtendedProperties, IScriptable

ManagedCPlusPlus

public ref class ForeignKey sealed : public ScriptNameObjectBase, ICreatable, IDroppable, IMarkForDrop, 
    IAlterable, IRenamable, IExtendedProperties, IScriptable

JSharp

public final class ForeignKey extends ScriptNameObjectBase implements ICreatable, IDroppable, 
    IMarkForDrop, IAlterable, IRenamable, IExtendedProperties, IScriptable

JScript

public final class ForeignKey extends ScriptNameObjectBase implements ICreatable, IDroppable, 
    IMarkForDrop, IAlterable, IRenamable, IExtendedProperties, IScriptable

Remarks

To get ForeignKey object properties, users can be a member of the public fixed server role.

To set ForeignKey object properties, users must have ALTER permission on the parent table or be a member of the db_owner fixed database role.

To create or drop a foreign key, users must have ALTER permission on the parent table or be a member of the db_owner fixed database role.

Inheritance Hierarchy

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.ForeignKey

Example

Creating, Altering, and Removing Foreign Keys

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

Target Platforms

Reference

Other Resources