Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Document] >  [Model] >  [Schema] >  [index]
Private  Storage   

class %Document.Model.Schema.index extends node

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 1


Summary

Properties
collection constraint data description disabled
displayName key name type

Methods
%AddToSaveSet %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %QuoteList %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %SerializeObject %SetModified %Validate
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Properties

• relationship collection as collection(XMLPROJECTION="none") [ Inverse = indexes,Cardinality = one ];
Thing that this property belongs to.
• property constraint as %String(MAXLEN=10,XMLCHOICELIST="idkey,primarykey,unique",XMLPROJECTION="attribute");
• property data as %String(MAXLEN=500,XMLPROJECTION="attribute");
Specifies a list of properties whose values are to be stored within this index.
• property key as %String(MAXLEN=500,XMLPROJECTION="attribute");
• property type as %String(MAXLEN=500,XMLCHOICELIST="standard,bitmap,bitmapextent,bitslice",XMLPROJECTION="attribute");
Specifies the type of the index.

Methods

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


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