InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > %Dictionary.CompiledIndex


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

SQL Table Name: %Dictionary.CompiledIndex

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property Abstract as %Boolean;
Specifies that this index should be abstract. Not projected to SQL, holds no data.
Property methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsDefined(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractReset(), AbstractSet()
property BuildPurge as %Boolean;
Property methods: BuildPurgeDisplayToLogical(), BuildPurgeGet(), BuildPurgeIsValid(), BuildPurgeLogicalToDisplay(), BuildPurgeNormalize(), BuildPurgeSet()
property CompilationSignature as %RawString;
Property methods: CompilationSignatureGet(), CompilationSignatureIsValid(), CompilationSignatureSet()
property CompilerGenerated as %Boolean;
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
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 methods: ConditionGet(), ConditionIsDefined(), ConditionIsValid(), ConditionReset(), ConditionSet()
property CoshardWith as %Dictionary.Classname;
Specifies the name of the class this class is cosharded with.
Property methods: CoshardWithGet(), CoshardWithIsDefined(), CoshardWithIsValid(), CoshardWithReset(), CoshardWithSet()
property Data as %RawString;
Specifies a list of properties whose values are to be stored within this index.
Property methods: DataGet(), DataIsDefined(), DataIsValid(), DataReset(), DataSet()
property Deprecated as %Boolean;
True if this index is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %RawString;
Specifies a description of the index.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), 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(), ExtentIsDefined(), ExtentIsValid(), ExtentLogicalToDisplay(), ExtentNormalize(), ExtentPrepare(), ExtentReset(), 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(), IdKeyIsDefined(), IdKeyIsValid(), IdKeyLogicalToDisplay(), IdKeyNormalize(), IdKeyReset(), 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(), IdKeyIsDefined(), IdKeyIsValid(), IdKeyLogicalToDisplay(), IdKeyNormalize(), IdKeyReset(), 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(), InternalIsDefined(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalReset(), 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.Identifier [ Required ];
The name of the index.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property NotInheritable as %Boolean;
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Origin as %RawString;
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Parameters as array of %RawString;
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(), PrimaryKeyIsDefined(), PrimaryKeyIsValid(), PrimaryKeyLogicalToDisplay(), PrimaryKeyNormalize(), PrimaryKeyReset(), PrimaryKeySet()
property Properties as %RawString;
Specifies a list of properties used to build this index. May also include a collation specification for each property.
Property methods: PropertiesGet(), PropertiesIsDefined(), PropertiesIsValid(), PropertiesReset(), 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(), SequenceNumberIsDefined(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberReset(), SequenceNumberSet()
property ShardKey as %Boolean;
If true then this index defines the components of the shard key.
Property methods: ShardKeyDisplayToLogical(), ShardKeyGet(), ShardKeyIsDefined(), ShardKeyIsValid(), ShardKeyLogicalToDisplay(), ShardKeyNormalize(), ShardKeyReset(), ShardKeySet()
property SqlName as %RawString;
Defines an alternate name for this index when referred to via SQL.
Property methods: SqlNameGet(), SqlNameIsDefined(), SqlNameIsValid(), SqlNameReset(), SqlNameSet()
property SystemAssigned as %Boolean;
Property methods: SystemAssignedDisplayToLogical(), SystemAssignedGet(), SystemAssignedIsValid(), SystemAssignedLogicalToDisplay(), SystemAssignedNormalize(), SystemAssignedSet()
property Type as %RawString;
Specifies the type of the index. Type 'key' is deprecated.
Property methods: TypeClassGet(), TypeClassIsDefined(), TypeClassIsValid(), TypeClassReset(), TypeClassSet(), TypeGet(), TypeIsDefined(), TypeIsValid(), TypeReset(), TypeSet()
property TypeClass as %Dictionary.Classname;
Specifies the FunctionalIndex class used to provide the implementation of the functional index interface.
Property methods: TypeClassGet(), TypeClassIsDefined(), TypeClassIsValid(), TypeClassReset(), 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(), UniqueIsDefined(), UniqueIsValid(), UniqueLogicalToDisplay(), UniqueNormalize(), UniqueReset(), 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()


classmethod %Exists(oid As %ObjectIdentity) as %Boolean [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 AbstractIsDefined() as %Boolean [ Language = objectscript ]
method AbstractReset() [ Language = objectscript ]
method AbstractSet(value As %String = "") as %Status [ Language = objectscript ]
method ConditionIsDefined() as %Boolean [ Language = objectscript ]
method ConditionReset() [ Language = objectscript ]
method ConditionSet(value As %String = "") as %Status [ Language = objectscript ]
method CoshardWithIsDefined() as %Boolean [ Language = objectscript ]
method CoshardWithReset() [ Language = objectscript ]
method CoshardWithSet(value As %String = "") as %Status [ Language = objectscript ]
method DataIsDefined() as %Boolean [ Language = objectscript ]
method DataReset() [ Language = objectscript ]
method DataSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method ExtentIsDefined() as %Boolean [ Language = objectscript ]
method ExtentReset() [ Language = objectscript ]
method ExtentSet(value As %String = "") as %Status [ Language = objectscript ]
method IdKeyIsDefined() as %Boolean [ Language = objectscript ]
method IdKeyReset() [ Language = objectscript ]
method IdKeySet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method PrimaryKeyIsDefined() as %Boolean [ Language = objectscript ]
method PrimaryKeyReset() [ Language = objectscript ]
method PrimaryKeySet(value As %String = "") as %Status [ Language = objectscript ]
method PropertiesIsDefined() as %Boolean [ Language = objectscript ]
method PropertiesReset() [ Language = objectscript ]
method PropertiesSet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method ShardKeyIsDefined() as %Boolean [ Language = objectscript ]
method ShardKeyReset() [ Language = objectscript ]
method ShardKeySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlNameReset() [ Language = objectscript ]
method SqlNameSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeClassIsDefined() as %Boolean [ Language = objectscript ]
method TypeClassReset() [ Language = objectscript ]
method TypeClassSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeIsDefined() as %Boolean [ Language = objectscript ]
method TypeReset() [ Language = objectscript ]
method TypeSet(value As %String = "") as %Status [ Language = objectscript ]
method UniqueIsDefined() as %Boolean [ Language = objectscript ]
method UniqueReset() [ Language = objectscript ]
method UniqueSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]


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