This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).


class %Document.Model.Schema.index extends %Document.Model.Schema.node

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

relationship collection as collection (XMLPROJECTION = "none") [ Inverse = indexes , Cardinality = one ];
Thing that this property belongs to.
Property methods: collectionGet(), collectionGetObject(), collectionGetObjectId(), collectionGetSwizzled(), collectionIsValid(), collectionNewObject(), collectionRClose(), collectionRExec(), collectionRFetch(), collectionRelate(), collectionSQLCompute(), collectionSet(), collectionUnRelate()
property constraint as %String (MAXLEN = 10, XMLCHOICELIST = "idkey,primarykey,unique", XMLPROJECTION = "attribute");
Property methods: constraintDisplayToLogical(), constraintGet(), constraintIsValid(), constraintLogicalToDisplay(), constraintLogicalToOdbc(), constraintNormalize(), constraintSet()
property data as %String (MAXLEN = 500, XMLPROJECTION = "attribute");
Specifies a list of properties whose values are to be stored within this index.
Property methods: dataDisplayToLogical(), dataGet(), dataIsValid(), dataLogicalToDisplay(), dataLogicalToOdbc(), dataNormalize(), dataSet()
property key as %String (MAXLEN = 500, XMLPROJECTION = "attribute");
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyLogicalToOdbc(), keyNormalize(), keySet()
property type as %String (MAXLEN = 500, XMLCHOICELIST = "standard,bitmap,bitmapextent,bitslice", XMLPROJECTION = "attribute");
Specifies the type of the index.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

Methods (Including Private)

method %Validate() as %Status
Test if this definition is valid.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window