CheckForeignKey

We assume that you have already learned what is described in:

If you want to find the right Other component for your purposes, see Others Comparison.

Short Summary

CheckForeignKey checks the validity of foreign key values and replaces invalid values by valid ones.

Component Same input metadata Sorted inputs Inputs Outputs Each to all outputs1) Java CTL
CheckForeignKey-no21-2-nono

1) Component sends each data record to all connected output ports.

Abstract

CheckForeignKey receives data records through two input ports. The data records on the first input port are compared with those one the second input port. If some value of the specified foreign key (input port 0) is not found within the values of the primary key (input port1), default value is given to the foreign key instead of its invalid value. Then all of the foreign records are sent to the first output port with the new (corrected) foreign key values and the original foreign records with invalid foreign key values can be sent to the optional second output port if it is connected.

Icon

Ports

Port typeNumberRequiredDescriptionMetadata
Input0yesFor data with foreign keyAny1
1yesFor data with primary keyAny2
Output0yesFor data with corrected keyInput 01)
1noFor data with invalid keyInput 01)

Legend:

1): Metadata cannot be propagated through this component.

CheckForeignKey Attributes

AttributeReqDescriptionPossible values
Basic
Foreign keyyesKey that is compared according to which both incoming data flows are compared and data records are distributed among different output ports. See Foreign Key for more information. 
Default foreign keyyesSequence of values corresponding to the Foreign key data types separated from each other by semicolon. Serves to replace invalid foreign key values. See Foreign Key for more information. 
Equal NULL By default, records with null values of fields are considered to be different. If set to true, nulls are considered to be equal.false (default) | true
Advanced
Hash table size Table for storing key values. Should be higher than the number of records with unique key values.512 (default) | properties
Deprecated
Primary key Sequence of field names from the second input port separated from each other by semicolon. See Deprecated: Primary Key for more information. 

Advanced Description