This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %Dictionary.CompiledIndex


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

SQL Table Name: %Dictionary.CompiledIndex

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter SQLENABLED = 1;

Properties (Including Private)

property BuildPurge as %Boolean;
Property methods: BuildPurgeDisplayToLogical(), BuildPurgeGet(), BuildPurgeIsValid(), BuildPurgeLogicalToDisplay(), BuildPurgeNormalize(), BuildPurgeSet()
property CompilationSignature as %CacheString;
Property methods: CompilationSignatureGet(), CompilationSignatureIsValid(), CompilationSignatureSet()
property CompilerGenerated as %Boolean;
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
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 methods: ConditionGet(), ConditionIsValid(), ConditionSet()
property Data as %CacheString;
Specifies a list of properties whose values are to be stored within this index.
Property methods: DataGet(), DataIsValid(), DataSet()
property Deprecated as %Boolean;
True if this index is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the index.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
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 methods: ExtentClose(), ExtentDisplayToLogical(), ExtentExecute(), ExtentFetch(), ExtentFetchRows(), ExtentFunc(), ExtentGet(), ExtentGetInfo(), ExtentGetODBCInfo(), ExtentIsValid(), ExtentLogicalToDisplay(), ExtentNormalize(), ExtentPrepare(), ExtentSendODBC(), ExtentSet()
property Final as %Boolean;
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Id as %Integer;
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdKeyDisplayToLogical(), IdKeyGet(), IdKeyIsValid(), IdKeyLogicalToDisplay(), IdKeyNormalize(), IdKeySet(), IdLogicalToDisplay(), IdNormalize(), IdSet()
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 methods: IdKeyDisplayToLogical(), IdKeyGet(), IdKeyIsValid(), IdKeyLogicalToDisplay(), IdKeyNormalize(), IdKeySet()
property InheritedId as %Boolean;
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property Internal as %Boolean;
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property KeywordError as %Boolean;
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
relationship Methods as array of %Dictionary.CompiledIndexMethod [ InitialExpression = $listbuild("%Dictionary.CompiledIndexMethod","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the index.
Property methods: NameGet(), NameIsValid(), NameSet()
property NotInheritable as %Boolean;
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Origin as %CacheString;
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Parameters as array of %CacheString;
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property PosInt as %Boolean;
Property methods: PosIntDisplayToLogical(), PosIntGet(), PosIntIsValid(), PosIntLogicalToDisplay(), PosIntNormalize(), PosIntSet()
property PrimaryKey as %Boolean;
Specifies that this index should be reported, via SQL, as being the Primary Key for this class.
Property methods: PrimaryKeyDisplayToLogical(), PrimaryKeyGet(), PrimaryKeyIsValid(), PrimaryKeyLogicalToDisplay(), PrimaryKeyNormalize(), PrimaryKeySet()
property Properties as %CacheString;
Specifies a list of properties used to build this index. May also include a collation specification for each property.
Property methods: PropertiesGet(), PropertiesIsValid(), PropertiesSet()
relationship PropertyCollection as array of %Dictionary.CompiledIndexProperty [ InitialExpression = $listbuild("%Dictionary.CompiledIndexProperty","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property methods: PropertyCollectionGet(), PropertyCollectionGetObject(), PropertyCollectionGetObjectId(), PropertyCollectionGetSwizzled(), PropertyCollectionIsEmpty(), PropertyCollectionIsValid(), PropertyCollectionNewObject(), PropertyCollectionRClose(), PropertyCollectionRExec(), PropertyCollectionRFetch(), PropertyCollectionRelate(), PropertyCollectionSQLCompute(), PropertyCollectionSet(), PropertyCollectionUnRelate()
property SequenceNumber as %Integer;
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SqlName as %CacheString;
Defines an alternate name for this index when referred to via SQL.
Property methods: SqlNameGet(), SqlNameIsValid(), SqlNameSet()
property SystemAssigned as %Boolean;
Property methods: SystemAssignedDisplayToLogical(), SystemAssignedGet(), SystemAssignedIsValid(), SystemAssignedLogicalToDisplay(), SystemAssignedNormalize(), SystemAssignedSet()
property Type as %CacheString;
Specifies the type of the index. Type 'key' is deprecated.
Property methods: TypeClassGet(), TypeClassIsValid(), TypeClassSet(), TypeGet(), TypeIsValid(), TypeSet()
property TypeClass as %Dictionary.CacheClassname;
Specifies the FunctionalIndex class used to provide the implementation of the functional index interface.
Property methods: TypeClassGet(), TypeClassIsValid(), TypeClassSet()
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.
Property methods: UniqueDisplayToLogical(), UniqueGet(), UniqueIsValid(), UniqueLogicalToDisplay(), UniqueNormalize(), UniqueSet()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Indices , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
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.

private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
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.
private method %OnNew(name As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
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 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 (BEFORE event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods (Including Private)