Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%Dictionary.StorageDataDefinition

persistent class %Dictionary.StorageDataDefinition extends %Library.Persistent

SQL Table Name: %Dictionary.StorageDataDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Attribute as %CacheString;
Attribute
Property methods: AttributeGet(), AttributeIsValid(), AttributeSet()
property Name as %CacheString [ 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(), NameSet()
property Structure as %CacheString [ InitialExpression = "listnode" ];
Specifies how the data is stored into a global node.
Property methods: StructureGet(), StructureSet()
property Subscript as %CacheString;
Subscript
Property methods: SubscriptGet(), SubscriptIsValid(), SubscriptSet()
relationship Values as array of %Dictionary.StorageDataValueDefinition [ InitialExpression = $listbuild("%Dictionary.StorageDataValueDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Value
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()

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 StructureIsValid(val As %String) as %Status
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 (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new tab