This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%Dictionary.CompiledTrigger

persistent class %Dictionary.CompiledTrigger extends %Library.Persistent, %Dictionary.CompiledTriggerQuery

SQL Table Name: %Dictionary.CompiledTrigger

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Code as %CacheString;
The code that is executed when the trigger is fired.
Property methods: CodeGet(), CodeIsValid(), CodeModeGet(), CodeModeIsValid(), CodeModeSet(), CodeSet()
property CodeMode as %CacheString;
Specifies how a given method is implemented: lines of code to be compiled, or a method that will generate the resulting method or object.
Property methods: CodeModeGet(), CodeModeIsValid(), CodeModeSet()
property CompilerGenerated as %Boolean;
CompilerGenerated
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property Deprecated as %Boolean;
True if this trigger is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the SQL trigger.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Event as %CacheString;
Specifies the SQL event that will fire the trigger.
Property methods: EventGet(), EventIsValid(), EventSet()
property Final as %Boolean;
Specifies that subclasses cannot override the definition of the SQL trigger.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Foreach as %CacheString;
Indicates if the trigger will be invoked for each row, for rows and objects, or for each statement
Property methods: ForeachGet(), ForeachIsValid(), ForeachSet()
property Id as %Integer;
Id
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
property InheritedId as %Boolean;
InheritedId
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(), InternalSet()
property KeywordError as %Boolean;
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
KeywordModified
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Language as %CacheString [ SqlFieldName = _Language ];
The language used to implement this trigger.
Property methods: LanguageGet(), LanguageIsValid(), LanguageSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the SQL trigger.
Property methods: NameGet(), NameIsValid(), NameSet()
property NewTable as %CacheString;
The name of the SQL table that holds old values for the trigger.
Property methods: NewTableGet(), NewTableIsValid(), NewTableSet()
property NotInheritable as %Boolean;
NotInheritable
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property OldTable as %CacheString;
The name of the SQL table that holds old values for the trigger.
Property methods: OldTableGet(), OldTableIsValid(), OldTableSet()
property Order as %Integer;
In the case of multiple triggers for the same EVENT and TIME, specifies the order in which the triggers should be fired.
Property methods: OrderDisplayToLogical(), OrderGet(), OrderIsValid(), OrderLogicalToDisplay(), OrderNormalize(), OrderSet()
property Origin as %CacheString;
Origin
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property SequenceNumber as %Integer;
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SqlName as %CacheString;
Specifies an alternate name when this trigger is used by SQL.
Property methods: SqlNameGet(), SqlNameIsValid(), SqlNameSet()
property TagGenerator as %CacheString;
TagGenerator
Property methods: TagGeneratorGet(), TagGeneratorIsValid(), TagGeneratorSet()
property Time as %CacheString [ SqlFieldName = _Time ];
Specifies whether the trigger is fired before or after the EVENT.
Property methods: TimeGet(), TimeIsValid(), TimeSet()
property UpdateColumnList as %CacheString;
Specifies one or more columns whose modification causes the trigger to be pulled by SQL.
Property methods: UpdateColumnListGet(), UpdateColumnListIsValid(), UpdateColumnListSet()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Triggers , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

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 %Library.CacheStorage or %Library.CacheSQLStorage.
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 %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

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

Triggers

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

Inherited Members

Inherited Methods

Feedback