Skip to main content

Foreign Key Syntax and Keywords

This reference describes the syntax and keywords that apply to a foreign key.

  • Syntax of Foreign Keys in Class Definitions – Describes the structure of a foreign key definition.
  • Internal – Specifies whether this foreign key definition is internal (not displayed in the class documentation).
  • NoCheck – Specifies whether InterSystems IRIS should check this foreign key constraint.
  • OnDelete – Specifies the action that this foreign key should cause in the current table when a record deleted in the foreign table is referenced by a record in the current table.
  • OnUpdate – Specifies the action that this foreign key should cause in the current table when the key value of a record in the foreign table is updated and that record is referenced by a record in the current table.
  • SqlName – Specifies an SQL alias for the foreign key.
Purpose of this instance: Draft documentation
DocReleaseID: IRIS2025.1
Content loaded from:
/staging/learning/iris-doc/2025.1.x/doc/cache/en-us/src/
/staging/learning/iris-doc/2025.1.x/doc/ensemble/en-us/src/
/staging/learning/iris-doc/2025.1.x/doc/security/en-us/src/
/staging/learning/iris-doc/2025.1.x/doc/iris/en-us/src/
Excluded items: EAST, EDICOM, EHL72, EHL7T, HXHCINST, HXHCRN, HXIHINST, HXIHRN, PAGE_healthcare
FeedbackOpens in a new tab