Skip to main content

%Dictionary.StorageIndexDefinition

persistent class %Dictionary.StorageIndexDefinition extends %Library.Persistent

SQL Table Name: %Dictionary.StorageIndexDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Location as %RawString;
Location
Property methods: LocationGet(), LocationIsValid()
property Name as %RawString [ Required ];
Name
Property methods: NameGet(), NameIsValid()
relationship parent as %Dictionary.StorageDefinition [ Required , Inverse = Indices , 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 %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 LocationIsDefined() as %Boolean
method LocationReset()
method LocationSet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value 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