DBTableCreateNewFkConstraintIfNecessary Method

public DBForeignKeyConstraint CreateNewFkConstraintIfNecessary(
	List<Pair<IProjectElementFieldMapTargetElement, IProjectElementFieldMapTargetElement>> fieldPairs,
	string fkName,
	Action<string> messageReportingFunc,
	bool forModelOnlyRelationship,
	out bool created
)

Public Function CreateNewFkConstraintIfNecessary ( 
	fieldPairs As List(Of Pair(Of IProjectElementFieldMapTargetElement, IProjectElementFieldMapTargetElement)),
	fkName As String,
	messageReportingFunc As Action(Of String),
	forModelOnlyRelationship As Boolean,
	<OutAttribute> ByRef created As Boolean
) As DBForeignKeyConstraint

Parameters

fieldPairs

Type: System.Collections.GenericListPairIProjectElementFieldMapTargetElement, IProjectElementFieldMapTargetElement
The field pairs. Value1 is Fk field, Value2 is Pk field

fkName

Type: SystemString
Name of the fk to create. Name is created from settings though not made unique across the db.

messageReportingFunc

Type: SystemActionString
The message reporting func. If specified, it is used to report a normal message to calling code's outer structures

forModelOnlyRelationship

Type: SystemBoolean
if set to true the fk is for a model-only relationship and only an existing FK, which isn't deleted matching the fields is returned

created

Type: SystemBoolean
if set to true this method created a new fk constraint. Set to false if the FK constraint was already present.

Return Value

Reference