Skip to main content


persistent class %Library.IndexDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.IndexDefinition

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.

This class represents a specific index description for a class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory

Method Inventory


property Attributes as %CacheString [ Calculated ];
This attribute is obsolete. Use 'Properties' instead.
Property methods: AttributesGet(), AttributesSet()
property ClassName as %CacheString;
A string containing the name of the class the index belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Condition as %CacheString;
A string containing a condition for the index.
Property methods: ConditionGet(), ConditionIsValid(), ConditionSet()
property Data as %CacheString;
A string containing a comma-delimited list of properties stored with the index.
Property methods: DataGet(), DataIsValid(), DataSet()
property Description as %CacheString;
A string containing a description of the index.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Extent as %CacheString;
A flag indicating whether the index is an extent index (1) or not (0).

An extent index is used to differentiate members of subclasses within extents.

Property methods: ExtentClose(), ExtentExecute(), ExtentFetch(), ExtentFunc(), ExtentGet(), ExtentGetInfo(), ExtentGetODBCInfo(), ExtentIsValid(), ExtentPrepare(), ExtentSendODBC(), ExtentSet()
property IdKey as %CacheString;
A flag indicating whether the index is an IDKEY index (1) or not (0).
Property methods: IdKeyGet(), IdKeyIsValid(), IdKeySet()
property Internal as %CacheString;
A flag indicating whether the index is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Name as %CacheString;
A string containing the name of the index.
Property methods: NameGet(), NameIsValid(), NameSet()
property PrimaryKey as %CacheString;
A flag indicating whether the index is the SQL primary key (1) or not (0).
Property methods: PrimaryKeyGet(), PrimaryKeyIsValid(), PrimaryKeySet()
property Properties as %CacheString;
A string containing a comma-delimited list of the properties the index is based upon.
Property methods: PropertiesGet(), PropertiesIsValid(), PropertiesSet()
property SQLName as %CacheString;
A string containing the name that this index as defined in SQL.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property SequenceNumber as %CacheString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()
property Type as %CacheString;
A string indicating the type of index to create, KEY or INDEX. A key index is build using only the index attributes while an INDEX uses both the index attributes and the IDKEY attributes (or system generated ID value).
Property methods: TypeGet(), TypeIsValid(), TypeSet()
property Unique as %CacheString;
A flag indicating whether the index is unique (1) or not (0).
Property methods: UniqueGet(), UniqueIsValid(), UniqueSet()


method AttributesGet() as %CacheString
method AttributesSet(newvalue As %CacheString) as %Status


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%Library.AbstractDefinition)

FeedbackOpens in a new tab