$fk

This object provides all information about a database foreign key
Each foreign key is retrieved from the entity class


Since : 2.0.7

Example :
   
   #foreach( $fk in $entity.databaseForeignKeys )
    $fk.name
   #end

Attributes and methods
.columns : List of 'Foreign Key Column' objects ( List of '$fkcol' )

Returns all the columns composing the foreign key
(sorted in the original database order)

Example :
   #foreach( $fkcol in $fk.columns )
   ...
   #end

.columnsCount : int

Returns the number of columns composing the foreign key

.deferrable : String

Returns the 'DEFERRABILITY' status ( 'NOT DEFERRABLE', 'INITIALLY IMMEDIATE', 'INITIALLY DEFERRED' )

.deferrableCode : int

Returns the 'DEFERRABILITY' status code ( MetaData Code : 5,6,7 )

.deleteRule : String

Returns the 'ON DELETE' rule ( 'NO ACTION', 'RESTRICT', 'SET NULL', 'SET DEFAULT', 'CASCADE' )

.deleteRuleCode : int

Returns the 'ON DELETE' rule code ( MetaData Code : 0,1,2,3,4 )

.name : String

Returns the name of the Foreign Key

.referencedTableName : String

Returns the name of the referenced table (the table referenced by the foreign key)

.tableName : String

Returns the name of the table holding the foreign key

.updateRule : String

Returns the 'ON UPDATE' rule ( 'NO ACTION', 'RESTRICT', 'SET NULL', 'SET DEFAULT', 'CASCADE' )

.updateRuleCode : int

Returns the 'ON UPDATE' rule code ( MetaData Code : 0,1,2,3,4 )