Class Reference
%FOI.Metadata.Index
Server:irisdocs2
Instance:IRISLATEST
User:UnknownUser
 
-
  [%SYS] >  [%FOI] >  [Metadata] >  [Index]
Private  Storage

index class %FOI.Metadata.Index extends %Library.FunctionalIndex, %Compiler.Type.Embedded

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
11


Summary

Methods
DeleteIndex Embedded Find GetMetadata
InsertIndex PurgeIndex SegmentFinalize SegmentInitialize
SegmentInsert SortBeginIndex SortEndIndex UpdateIndex


Methods

• classmethod DeleteIndex(id As %RawString, args... As %Binary)
This method is invoked when an existing instance of a class is deleted.
• classmethod Find(pSearch As %Binary) as %Library.Binary [ SQLProc = ]
• classmethod GetMetadata(qualifiedName, format As %String = "XEP", refresh As %Integer = 0) as %String
• classmethod InsertIndex(id As %RawString, args... As %Binary)
This method is invoked when a new instance of a class is inserted into the database.
• classmethod PurgeIndex()
• classmethod SegmentFinalize(ByRef indexBuffer As %RawString, startID As %RawString, endID As %RawString)
This method is called when the index builder is finalizing a segment. Use this method to implement any segment cleanup work or to complete the filing of the segment. Parallel index builds typically construct segments of the index in memory and this method is a good place to copy temporary structures to the permanent index structure.
• classmethod SegmentInitialize(ByRef indexBuffer As %RawString, startID As %RawString, endID As %RawString)
This method is called by the parallel index build to initialize an index segment when constructing index entries for one segment of the extent. Parallel index builds typically construct indexes in memory for segments of 64k instances/rows.
• classmethod SegmentInsert(ByRef indexBuffer As %RawString, id As %RawString, args... As %Binary)
• classmethod SortBeginIndex()
• classmethod SortEndIndex(commit As %Integer = 1)
• classmethod UpdateIndex(id As %RawString, args... As %Binary)
This method is invoked when an existing instance of a class is updated.


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