Skip to main content


persistent class %Dictionary.StorageDataDefinition extends %Library.Persistent

SQL Table Name: %Dictionary.StorageDataDefinition

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property Attribute as %RawString;
Property methods: AttributeGet(), AttributeIsValid()
property ColumnarGlobal as %RawString;
Specifies the name of the global this Columnar column is stored in.
Property methods: ColumnarGlobalGet(), ColumnarGlobalIsValid()
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(), NameIsValid()
property Structure as %RawString [ InitialExpression = "listnode" ];
Specifies how the data is stored into a global node.
Property methods: StructureGet()
property Subscript as %RawString;
Property methods: SubscriptGet(), SubscriptIsValid()
relationship Values as array of %Dictionary.StorageDataValueDefinition [ InitialExpression = $listbuild("%Dictionary.StorageDataValueDefinition","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.StorageDefinition [ Required , Inverse = Data , 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 AttributeIsDefined() as %Boolean
method AttributeReset()
method AttributeSet(value As %String = "") as %Status
method ColumnarGlobalIsDefined() as %Boolean
method ColumnarGlobalReset()
method ColumnarGlobalSet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value As %String = "") as %Status
method StructureIsDefined() as %Boolean
classmethod StructureIsValid(val As %String) as %Status
method StructureReset()
method StructureSet(value As %String = "") as %Status
method SubscriptIsDefined() as %Boolean
method SubscriptReset()
method SubscriptSet(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 (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new tab