Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%Dictionary] >  [CompiledIndex]
Private  Storage   

persistent class %Dictionary.CompiledIndex extends %Persistent, %Dictionary.CompiledIndexQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 35 62 1 2


Summary

Properties
Abstract BuildPurge CompilationSignature CompilerGenerated
Condition CoshardWith Data Deprecated
Description Extent Final Id
IdKey InheritedId Internal KeywordError
KeywordModified Methods Name NotInheritable
Origin Parameters PosInt PrimaryKey
Properties PropertyCollection SequenceNumber ShardKey
SqlName SystemAssigned Type TypeClass
Unique parent

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%IsA %IsModified %IsNull %KillExtent
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject AbstractIsDefined AbstractReset
AbstractSet ConditionIsDefined ConditionReset ConditionSet
CoshardWithIsDefined CoshardWithReset CoshardWithSet DataIsDefined
DataReset DataSet DeprecatedIsDefined DeprecatedReset
DeprecatedSet DescriptionIsDefined DescriptionReset DescriptionSet
ExtentIsDefined ExtentReset ExtentSet IdKeyIsDefined
IdKeyReset IdKeySet InternalIsDefined InternalReset
InternalSet NameIsDefined NameReset NameSet
PrimaryKeyIsDefined PrimaryKeyReset PrimaryKeySet PropertiesIsDefined
PropertiesReset PropertiesSet SequenceNumberIsDefined SequenceNumberReset
SequenceNumberSet ShardKeyIsDefined ShardKeyReset ShardKeySet
SqlNameIsDefined SqlNameReset SqlNameSet SummaryClose
SummaryExecute SummaryFetch TypeClassIsDefined TypeClassReset
TypeClassSet TypeIsDefined TypeReset TypeSet
UniqueIsDefined UniqueReset UniqueSet parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Abstract as %Boolean;
Specifies that this index should be abstract. Not projected to SQL, holds no data.
• property BuildPurge as %Boolean;
BuildPurge
• property CompilationSignature as %RawString;
CompilationSignature
• property CompilerGenerated as %Boolean;
CompilerGenerated
• property Condition as %RawString;
In the case of a conditional index, specifies the condition that must be met for an entry to be included in the index.
• property CoshardWith as %Dictionary.Classname;
Specifies the name of the class this class is cosharded with.
• property Data as %RawString;
Specifies a list of properties whose values are to be stored within this index.
• property Deprecated as %Boolean;
True if this index is deprecated.
• property Description as %RawString;
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.Identifier [ Required ];
The name of the index.
• property NotInheritable as %Boolean;
NotInheritable
• property Origin as %RawString;
Origin
• property Parameters as array of %RawString;
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 %RawString;
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 ShardKey as %Boolean;
If true then this index defines the components of the shard key.
• property SqlName as %RawString;
Defines an alternate name for this index when referred to via SQL.
• property SystemAssigned as %Boolean;
SystemAssigned
• property Type as %RawString;
Specifies the type of the index. Type 'key' is deprecated.
• property TypeClass as %Dictionary.Classname;
Specifies the FunctionalIndex class used to provide the implementation of the functional index interface.
• 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

Methods

• 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, timeout As %Integer) as %Status
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
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 AbstractIsDefined() as %Boolean
• method AbstractReset()
• method AbstractSet(value As %String = "") as %Status
This is a Set accessor method for the Abstract property.
• method ConditionIsDefined() as %Boolean
• method ConditionReset()
• method ConditionSet(value As %String = "") as %Status
This is a Set accessor method for the Condition property.
• method CoshardWithIsDefined() as %Boolean
• method CoshardWithReset()
• method CoshardWithSet(value As %String = "") as %Status
This is a Set accessor method for the CoshardWith property.
• method DataIsDefined() as %Boolean
• method DataReset()
• method DataSet(value As %String = "") as %Status
This is a Set accessor method for the Data property.
• method DeprecatedIsDefined() as %Boolean
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "") as %Status
This is a Set accessor method for the Deprecated property.
• method DescriptionIsDefined() as %Boolean
• method DescriptionReset()
• method DescriptionSet(value As %String = "") as %Status
This is a Set accessor method for the Description property.
• method ExtentIsDefined() as %Boolean
• method ExtentReset()
• method ExtentSet(value As %String = "") as %Status
This is a Set accessor method for the Extent property.
• method IdKeyIsDefined() as %Boolean
• method IdKeyReset()
• method IdKeySet(value As %String = "") as %Status
This is a Set accessor method for the IdKey property.
• method InternalIsDefined() as %Boolean
• method InternalReset()
• method InternalSet(value As %String = "") as %Status
This is a Set accessor method for the Internal property.
• method NameIsDefined() as %Boolean
• method NameReset()
• method NameSet(value As %String = "") as %Status
This is a Set accessor method for the Name property.
• method PrimaryKeyIsDefined() as %Boolean
• method PrimaryKeyReset()
• method PrimaryKeySet(value As %String = "") as %Status
This is a Set accessor method for the PrimaryKey property.
• method PropertiesIsDefined() as %Boolean
• method PropertiesReset()
• method PropertiesSet(value As %String = "") as %Status
This is a Set accessor method for the Properties property.
• method SequenceNumberIsDefined() as %Boolean
• method SequenceNumberReset()
• method SequenceNumberSet(value As %String = "") as %Status
This is a Set accessor method for the SequenceNumber property.
• method ShardKeyIsDefined() as %Boolean
• method ShardKeyReset()
• method ShardKeySet(value As %String = "") as %Status
This is a Set accessor method for the ShardKey property.
• method SqlNameIsDefined() as %Boolean
• method SqlNameReset()
• method SqlNameSet(value As %String = "") as %Status
This is a Set accessor method for the SqlName property.
• method TypeClassIsDefined() as %Boolean
• method TypeClassReset()
• method TypeClassSet(value As %String = "") as %Status
This is a Set accessor method for the TypeClass property.
• method TypeIsDefined() as %Boolean
• method TypeReset()
• method TypeSet(value As %String = "") as %Status
This is a Set accessor method for the Type property.
• method UniqueIsDefined() as %Boolean
• method UniqueReset()
• method UniqueSet(value As %String = "") as %Status
This is a Set accessor method for the Unique property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

•trigger OnDelete (BEFORE event DELETE)
•trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.