persistent class %Dictionary.CompiledIndex
extends %Persistent, %Dictionary.CompiledIndexQuery
• parameter SQLENABLED = 1;
• property BuildPurge
as %Boolean;
BuildPurge
• property CompilationSignature
as %CacheString;
CompilationSignature
• property CompilerGenerated
as %Boolean;
CompilerGenerated
• property Condition
as %CacheString;
In the case of a conditional index, specifies the condition that must be met for an entry to be included in the index.
• property Data
as %CacheString;
Specifies a list of properties whose values are to be stored within this index.
• property Description
as %CacheString;
Specifies a description of the index.
• property Extent
as %Boolean;
An extent index is used to keep track of which object instances belong to a subclass. When using bitmap indices, then an extent index is automatically maintained and there is no need to define one.
• property Final
as %Boolean;
Final
• property Id
as %Integer;
Id
• property IdKey
as %Boolean;
Specifies that the property or properties defined for this index will be used to form the Object Identity value for this object. This value is used to uniquely locate persistent object instances.
• property InheritedId
as %Boolean;
InheritedId
• property Internal
as %Boolean;
If true, then do not display this item in automatic documentation.
• property KeywordError
as %Boolean;
KeywordError
• property KeywordModified
as %Boolean;
KeywordModified
• relationship Methods
as %Dictionary.CompiledIndexMethod [ Inverse = parent,Cardinality = children ];
Method
• property Name
as %Dictionary.CacheIdentifier;
The name of the index.
• property NotInheritable
as %Boolean;
NotInheritable
• property Origin
as %CacheString;
Origin
• property Parameters
as array of %CacheString;
Parameter
• property PosInt
as %Boolean;
PosInt
• property PrimaryKey
as %Boolean;
Specifies that this index should be reported, via SQL, as being the Primary Key for this class.
• property Properties
as %CacheString;
Specifies a list of properties used to build this index. May also include a collation specification for each property.
• relationship PropertyCollection
as %Dictionary.CompiledIndexProperty [ Inverse = parent,Cardinality = children ];
Property
• property SequenceNumber
as %Integer;
SequenceNumber
• property SqlName
as %CacheString;
Defines an alternate name for this index when referred to via SQL.
• property SystemAssigned
as %Boolean;
SystemAssigned
• property Type
as %CacheString;
Specifies the type of the index.
• property Unique
as %Boolean [ SqlFieldName = _Unique ];
Specifies whether this is a unique index. The property or properties indexed by a unique index are constrained to have unique values. This means that no two instances can have the same collated value within the extent among the set of all objects of the class that defines the index.
• relationship parent
as %Dictionary.CompiledClass [ Inverse = Indices,Cardinality = parent ];
Pointer to the containing parent object
• classmethod %Exists(oid As %ObjectIdentity)
as %Boolean
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)
as %Status
%LockId()
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
%UnlockId()
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.
• index (IDKEY on Name) [IdKey];
• trigger OnDelete
(BEFORE event DELETE)• trigger OnInsertUpdate
(BEFORE event INSERT/UPDATE)
