Skip to main content


persistent class %Dictionary.CompiledForeignKey extends %Library.Persistent, %Dictionary.CompiledForeignKeyQuery

SQL Table Name: %Dictionary.CompiledForeignKey

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property CompilerGenerated as %Boolean;
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property Deprecated as %Boolean;
True if this foreign key is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize()
property Description as %RawString;
Supplies a description of the foreign key.
Property methods: DescriptionGet(), DescriptionIsValid()
property Final as %Boolean;
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Id as %Integer;
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
property InheritedId as %Boolean;
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property Internal as %Boolean;
If true then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize()
property KeywordError as %Boolean;
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Name as %Dictionary.Identifier [ Required ];
Defines a name for the key. It must be a valid class member name and must not conflict with any existing member name.
Property methods: NameGet(), NameIsValid()
property NoCheck as %Boolean;
Specifies whether InterSystems IRIS should check this foreign key constraint.
Property methods: NoCheckDisplayToLogical(), NoCheckGet(), NoCheckIsValid(), NoCheckLogicalToDisplay(), NoCheckNormalize()
property NotInheritable as %Boolean;
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property OnDelete as %RawString;
Specifies what referential action to take when the key value is deleted from the foreign table.
Property methods: OnDeleteGet(), OnDeleteIsValid()
property OnUpdate as %RawString;
Specifies what referential action to take when the key value is updated in the foreign table.
Property methods: OnUpdateGet(), OnUpdateIsValid()
property Origin as %RawString;
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Properties as %RawString;
Specifies one or more properties whose values are used to constrain the value of the foreign key.
Property methods: PropertiesGet(), PropertiesIsValid()
property ReferencedClass as %Dictionary.Classname;
Specifies the name of the class containing the key referred to by this foreign key definition.
Property methods: ReferencedClassGet(), ReferencedClassIsValid()
property ReferencedKey as %RawString;
Specifies the key name of a unique index within a class that provides the set of allowed values for this foreign key.
Property methods: ReferencedKeyGet(), ReferencedKeyIsValid()
property SequenceNumber as %Integer;
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()
property SqlName as %RawString;
Specifies an alternate name for this foreign key when referred to via SQL.
Property methods: SqlNameGet(), SqlNameIsValid()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = ForeignKeys , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()


classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
method DeprecatedIsDefined() as %Boolean
method DeprecatedReset()
method DeprecatedSet(value As %String = "") as %Status
method DescriptionIsDefined() as %Boolean
method DescriptionReset()
method DescriptionSet(value As %String = "") as %Status
method InternalIsDefined() as %Boolean
method InternalReset()
method InternalSet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value As %String = "") as %Status
method NoCheckIsDefined() as %Boolean
method NoCheckReset()
method NoCheckSet(value As %String = "") as %Status
method OnDeleteIsDefined() as %Boolean
method OnDeleteReset()
method OnDeleteSet(value As %String = "") as %Status
method OnUpdateIsDefined() as %Boolean
method OnUpdateReset()
method OnUpdateSet(value As %String = "") as %Status
method PropertiesIsDefined() as %Boolean
method PropertiesReset()
method PropertiesSet(value As %String = "") as %Status
method ReferencedClassIsDefined() as %Boolean
method ReferencedClassReset()
method ReferencedClassSet(value As %String = "") as %Status
method ReferencedKeyIsDefined() as %Boolean
method ReferencedKeyReset()
method ReferencedKeySet(value As %String = "") as %Status
method SequenceNumberIsDefined() as %Boolean
method SequenceNumberReset()
method SequenceNumberSet(value As %String = "") as %Status
method SqlNameIsDefined() as %Boolean
method SqlNameReset()
method SqlNameSet(value As %String = "") as %Status
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status


index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()


trigger OnDelete (BEFORE event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new tab