InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > %Dictionary.CompiledStorageData


persistent class %Dictionary.CompiledStorageData extends %Library.Persistent

SQL Table Name: %Dictionary.CompiledStorageData

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property Attribute as %RawString;
Property methods: AttributeGet(), AttributeIsDefined(), AttributeIsValid(), AttributeReset(), AttributeSet()
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 %RawString [ Required ];
Specifies the name of the StorageData definition. This name must be a valid storage member name and must not conflict with any other StorageData names.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property Structure as %RawString;
Specifies how the data is stored into a global node.
Property methods: StructureGet(), StructureIsDefined(), StructureIsValid(), StructureReset(), StructureSet()
property Subscript as %RawString;
Property methods: SubscriptGet(), SubscriptIsDefined(), SubscriptIsValid(), SubscriptReset(), SubscriptSet()
relationship Values as array of %Dictionary.CompiledStorageDataValue [ InitialExpression = $listbuild("%Dictionary.CompiledStorageDataValue","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property methods: ValuesGet(), ValuesGetObject(), ValuesGetObjectId(), ValuesGetSwizzled(), ValuesIsEmpty(), ValuesIsValid(), ValuesNewObject(), ValuesRClose(), ValuesRExec(), ValuesRFetch(), ValuesRelate(), ValuesSQLCompute(), ValuesSet(), ValuesUnRelate()
relationship parent as %Dictionary.CompiledStorage [ Required , Inverse = Data , 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()


classmethod %Exists(oid As %ObjectIdentity) as %Boolean [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 AttributeIsDefined() as %Boolean [ Language = objectscript ]
method AttributeReset() [ Language = objectscript ]
method AttributeSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method StructureIsDefined() as %Boolean [ Language = objectscript ]
method StructureReset() [ Language = objectscript ]
method StructureSet(value As %String = "") as %Status [ Language = objectscript ]
method SubscriptIsDefined() as %Boolean [ Language = objectscript ]
method SubscriptReset() [ Language = objectscript ]
method SubscriptSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]


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