%ExtentMgr.Catalog.Index
hidden persistent class %ExtentMgr.Catalog.Index extends %Library.Persistent
SQL Table Name: %ExtentMgr_Catalog.Index
Property Inventory
Properties
relationship Extent as %ExtentMgr.Catalog.Extent [ Required , Inverse = Indices , Cardinality = parent ];
Property methods: ExtentGet(), ExtentGetObject(), ExtentGetObjectId(), ExtentGetStored(), ExtentGetSwizzled(), ExtentIsValid(), ExtentNewObject(), ExtentOnDelete(), ExtentRClose(), ExtentRExec(), ExtentRFetch(), ExtentRelate(), ExtentSQLCompute(), ExtentSet(), ExtentSetObject(), ExtentSetObjectId(), ExtentUnRelate(), ExtentUnSwizzle()
property Key as %String);
Key is the index key - the definition of the index properties and collations is any are specified.
If no collation is specified for a key component then the collation is based on the component definiton.
Property methods: KeyDisplayToLogical(), KeyGet(), KeyGetStored(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()
property Name as %String (COLLATION = "EXACT", MAXLEN = 255, TRUNCATE = 1) [ Required ];
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Status as %Integer;
Status indicates the current status of the index structure and whether it needs to be built
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusNormalize(), StatusSet()
property Structure as %String;
Structure is STANDARD, BITMAP or BITSLICE
Property methods: StructureDisplayToLogical(), StructureGet(), StructureGetStored(), StructureIsValid(), StructureLogicalToDisplay(), StructureLogicalToOdbc(), StructureNormalize(), StructureSet()
property Type as %String;
The index type is either IDKEY, PKEY, UNIQUE, EXTENT, STANDARD
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
Indexes
index (IDK on Name) [IdKey, Type = key];
Index methods: IDKCheck(), IDKDelete(), IDKExists(), IDKOpen(), IDKSQLCheckUnique(), IDKSQLExists(), IDKSQLFindPKeyByConstraint(), IDKSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
Storage
Storage Model: CacheStorage (%ExtentMgr.Catalog.Index)
{%%PARENT}($$$cCLASSindex)(ID) | = | Type
Structure
Status
Key
|