ISqlForeignKeyConstraint Interface

Models a foreign key constraint.

Namespace:  Microsoft.Data.Schema.Sql.SchemaModel
Assembly:  Microsoft.Data.Schema.Sql (in Microsoft.Data.Schema.Sql.dll)

Syntax

'Declaration
Public Interface ISqlForeignKeyConstraint _
    Inherits ISqlConstraint, ISqlExtendedPropertyHost, ISqlModelElement, IScriptSourcedModelElement,  _
    IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

public interface ISqlForeignKeyConstraint : ISqlConstraint, 
    ISqlExtendedPropertyHost, ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, 
    IModelEntity, IModelAnnotationHolder

public interface class ISqlForeignKeyConstraint : ISqlConstraint, 
    ISqlExtendedPropertyHost, ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, 
    IModelEntity, IModelAnnotationHolder

type ISqlForeignKeyConstraint =  
    interface
        interface ISqlConstraint
        interface ISqlExtendedPropertyHost
        interface ISqlModelElement
        interface IScriptSourcedModelElement
        interface IModelElement
        interface IModelPropertyContainer
        interface IModelEntity
        interface IModelAnnotationHolder
    end

public interface ISqlForeignKeyConstraint extends ISqlConstraint, ISqlExtendedPropertyHost, ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

The ISqlForeignKeyConstraint type exposes the following members.

Properties

	Name	Description
	Columns	Gets the list of the local columns that participate in the foreign key.
	DefiningTable	Gets or sets the table to which the constraint applies. (Inherited from ISqlConstraint.)
	ElementClass	Gets the metadata class for an element. (Inherited from IModelElement.)
	ExtendedProperties	Gets the list of extended properties for this object. (Inherited from ISqlExtendedPropertyHost.)
	ForeignColumns	Gets the list of the columns in the foreign table that form the foreign key.
	ForeignTable	Gets or sets the foreign table.
	IsDisabled	Gets or sets a value that indicates whether the constraint is disabled. (Inherited from ISqlConstraint.)
	IsNotForReplication	Gets or sets a value that models the NOT FOR REPLICATION option.
	Model	Gets the model reference. (Inherited from IModelEntity.)
	Name	Gets or sets the name of the element. (Inherited from IModelElement.)
	OnDeleteAction	Gets or sets a value that models the ON DELETE option.
	OnUpdateAction	Gets or sets a value that models the ON UPDATE option.
	PrimarySource	Gets information about the primary source for the element. (Inherited from IScriptSourcedModelElement.)
	ResolutionStatus	Gets or sets the value of the model element resolution status. (Inherited from IModelElement.)
	SecondarySources	Gets a list of secondary sources for the element. (Inherited from IScriptSourcedModelElement.)
	SourceCodePositions	Gets the list of sources that define this element. (Inherited from IModelElement.)
	ValidationStatus	Gets or sets the value of the model element validation status. (Inherited from IModelElement.)

Top

Methods

	Name	Description
	AddAnnotation	Adds the given annotation to this element. (Inherited from IModelAnnotationHolder.)
	Delete	Deletes this instance from the model. (Inherited from IModelElement.)
	GetAnnotations()	Returns a list of annotations attached to this element. (Inherited from IModelAnnotationHolder.)
	GetAnnotations(Type)	Returns a list of attached annotations of the given type. (Inherited from IModelAnnotationHolder.)
	GetAnnotations(ModelIdentifier)	Returns a list of attached annotations that have the given identifier. (Inherited from IModelAnnotationHolder.)
	GetAnnotations(ModelIdentifier, Type)	(Inherited from IModelAnnotationHolder.)
	GetAnnotations<TType>()	Returns all attached model annotations that implement the given annotation type and have the specified model identifier. (Inherited from IModelAnnotationHolder.)
	GetAnnotations<TType>(ModelIdentifier)	(Inherited from IModelAnnotationHolder.)
	GetColumnsRelationship	Returns an IModelMultiRelationship between this and the associated ISqlColumn.
	GetComposingChildren	Returns a list of composing children for this element. (Inherited from IModelElement.)
	GetDefiningTableRelationship	Returns an IModelSingleRelationship between this and the associated ISqlSpecifiesTable. (Inherited from ISqlConstraint.)
	GetExtendedPropertiesRelationship	Returns an IModelReverseMultiRelationship between this and the associated ISqlExtendedProperty. (Inherited from ISqlExtendedPropertyHost.)
	GetForeignColumnsRelationship	Returns an IModelMultiRelationship between this and the associated ISqlColumn.
	GetForeignTableRelationship	Returns an IModelSingleRelationship between this and the associated ISqlTable.
	GetHierarchicalChildren	Returns a list of hierarchical children for this element. (Inherited from IModelElement.)
	GetOwnerInfo	Returns information about the element owner. (Inherited from IModelElement.)
	GetProperty<TProperty>	Gets the specified property. (Inherited from IModelPropertyContainer.)
	GetReferencedDanglingRelationshipEntries	Returns a list of the relationship entries, where this element is on the left side and there is either no element on the right side of the relationship, or the element on the right does not exist in the model. (Inherited from IModelElement.)
	GetReferencedElements	Returns a list of the elements that are in a relationship with this element, where this element is on the left side of the relationship. (Inherited from IModelElement.)
	GetReferencedRelationshipEntries	Returns a list of the relationship entries, where this element is on the left side. (Inherited from IModelElement.)
	GetReferencingElements	Returns a list of the elements that are in a relationship with this element, where this element is on the right side. (Inherited from IModelElement.)
	GetReferencingRelationshipEntries	Returns a list of the relationship entries, where this element is on the right side. (Inherited from IModelElement.)
	GetRelationship(ModelRelationshipClass)	Returns the requested relationship by using the provided metadata. (Inherited from IModelElement.)
	GetRelationship<TFrom, TTo>(ModelRelationshipClass)	Returns a relationship where the two related elements are of the specified types. (Inherited from IModelElement.)
	GetRelationshipEntrySources	Returns a collection of source information about the given relationship. (Inherited from IScriptSourcedModelElement.)
	GetRelationships	Returns a list of the relationships in this element. (Inherited from IModelElement.)
	IsDeleted	Specifies whether the object is deleted. (Inherited from IModelElement.)
	IsExternal	Returns a value that indicates whether the object was loaded from an external source and is not a part of the schema model. (Inherited from IModelElement.)
	RemoveAnnotation	Removes the specified annotation from this model element. (Inherited from IModelAnnotationHolder.)
	SetProperty<TProperty>	Sets the specified property. (Inherited from IModelPropertyContainer.)

Top

See Also

Reference

Microsoft.Data.Schema.Sql.SchemaModel Namespace