Share via


IForeignKeyConstraint Interface

Represents a SQL Server FOREIGN KEY constraint.

Namespace:  Microsoft.SqlServer.Management.SqlParser.Metadata
Assembly:  Microsoft.SqlServer.Management.SqlParser (in Microsoft.SqlServer.Management.SqlParser.dll)

Syntax

'Declaration
Public Interface IForeignKeyConstraint _
    Inherits IConstraint, IMetadataObject
'Usage
Dim instance As IForeignKeyConstraint
public interface IForeignKeyConstraint : IConstraint, 
    IMetadataObject
public interface class IForeignKeyConstraint : IConstraint, 
    IMetadataObject
type IForeignKeyConstraint =  
    interface
        interface IConstraint
        interface IMetadataObject
    end
public interface IForeignKeyConstraint extends IConstraint, IMetadataObject

The IForeignKeyConstraint type exposes the following members.

Properties

  Name Description
Public property Columns Gets the columns that are included in the foreign key.
Public property DeleteAction Gets a ForeignKeyAction value that specifies the action taken when a row that is referenced by the foreign key is deleted.
Public property IsChecked Gets a value that indicates whether the FOREIGN KEY constraint applies to new data only or also to existing data.
Public property IsEnabled Gets a value that indicates whether the FOREIGN KEY constraint is enabled.
Public property IsSystemNamed Gets a value that indicates whether the constraint is named by the system or by the user. (Inherited from IConstraint.)
Public property Name Gets the name of the metadata object. (Inherited from IMetadataObject.)
Public property NotForReplication Gets a value that indicates whether the FOREIGN KEY constraint is available for replication.
Public property Parent Gets the ITabular object that is the parent of this object. (Inherited from IConstraint.)
Public property ReferencedTable Gets the ITable object that contains the primary key that is referenced by the foreign key.
Public property Type Gets a ConstraintType value that indicates the constraint type. (Inherited from IConstraint.)
Public property UpdateAction Gets a ForeignKeyAction value that specifies the action taken when a row that is referenced by the foreign key is updated.

Top

Methods

  Name Description
Public method Accept<T> Accepts a visit from the specified IMetadataObjectVisitor<T> object. (Inherited from IMetadataObject.)

Top