Knight Data Access Layer
ForeignKeyExists Method (DataHelper)
Example 




KellermanSoftware.NetDataAccessLayer Namespace > DataHelper Class : ForeignKeyExists Method
Name of the table.
Name of the column.
Name of the parent table.
Name of the parent column.
Returns true if the Foreign Key Exists
Syntax
Public Function ForeignKeyExists( _
   ByVal tableName As String, _
   ByVal columnName As String, _
   ByVal parentTableName As String, _
   ByVal parentColumnName As String _
) As Boolean
Dim instance As DataHelper
Dim tableName As String
Dim columnName As String
Dim parentTableName As String
Dim parentColumnName As String
Dim value As Boolean
 
value = instance.ForeignKeyExists(tableName, columnName, parentTableName, parentColumnName)
public bool ForeignKeyExists( 
   string tableName,
   string columnName,
   string parentTableName,
   string parentColumnName
)
public: bool ForeignKeyExists( 
   string* tableName,
   string* columnName,
   string* parentTableName,
   string* parentColumnName
) 
public:
bool ForeignKeyExists( 
   String^ tableName,
   String^ columnName,
   String^ parentTableName,
   String^ parentColumnName
) 

Parameters

tableName
Name of the table.
columnName
Name of the column.
parentTableName
Name of the parent table.
parentColumnName
Name of the parent column.

Return Value

true if the foreign key exists, false otherwise.
Example
//Get the current thread static safe instance of the helper
IDataHelper db = DataHelper.SessionFactory();
 
//Specify User Name and License Key from the receipt, leave blank for trial mode
//db.UserName = "John Smith 1234";
//db.LicenseKey = "asdfl219==";
 
//Log to the console
db.EnableLogging();
 
//This will automatically create all tables for the class Movie with all associated parents and children
db.Setup("Tests.Shared.TestClasses.Movie");
 
//This will be true
bool foreignKeyExists = db.ForeignKeyExists("Movies", "StudioId", "Studios", "StudioId");
 
//Get the constraints
List<ForeignKeyConstraint> constraints = db.GetAllConstraints();
'Get the current thread static safe instance of the helper
Dim db As IDataHelper = DataHelper.SessionFactory()
 
'Specify User Name and License Key from the receipt, leave blank for trial mode
'db.UserName = "John Smith 1234";
'db.LicenseKey = "asdfl219==";
 
'Log to the console
db.EnableLogging()
 
'This will automatically create all tables for the class Movie with all associated parents and children
db.Setup("Tests.Shared.TestClasses.Movie")
 
'This will be true
Dim foreignKeyExists As Boolean = db.ForeignKeyExists("Movies", "StudioId", "Studios", "StudioId")
 
'Get the constraints
Dim constraints As List(Of ForeignKeyConstraint) = db.GetAllConstraints()
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

DataHelper Class
DataHelper Members