ForeignKey Class

The ForeignKey object represents a Microsoft SQL Server foreign key.

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

Syntax

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

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

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

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

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

Remarks

Updated text:

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

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

How to: Create, Alter, and Remove a Foreign Key in Visual Basic .NET

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

ForeignKey Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Creating, Altering, and Removing Foreign Keys
Creating and Modifying FOREIGN KEY Constraints
CREATE TABLE (Transact-SQL)

Change History