For information on converting to InterSystems IRIS, see the
InterSystems IRIS Adoption Guide
and the InterSystems IRIS In-Place Conversion Guide,
both available on the WRC Distributions page (login required).
The %CacheStorage class contains the storage interface methods
for the Caché default storage structure. The storage interface
methods, which are implemented as method generators, work in conjunction
with the persistent interface methods of the %Persistent class to
provide persistent behavior for objects.
The methods of %CacheStorage are not meant to be called directly.
Use the methods of the %Persistent class which, in turn, call the
appropriate %CacheStorage method.
Load object from persistent storage into memory. The caller is responsible for calling %IdSet()
Don't include class name with id in input parameter
state is the physical data where the structure of state mirrors the structure of the object on disk
obj is an array, subscripted by property name where each array element is equal to the property value named as the subscript.
Inherited description: Deletes all entries from each index specified in the idxlist argument.
If idxlist is empty then all indices that originate
in the class are purged. The index definition remains intact.
If pIgnoreIndexList is defined, it should be a $listbuild of index names that should not be purged.
This argument allows you to purge all indices except those defined in pIgnoreIndexList.
The default value of this argument is "", which means all indices, or all indices specified in pIndexList, will be purged.
Files the indices for all objects whose ID is in the range defined by pStartId and pEndId.
If pEndID is null then it defaults to pStartId. If pStartId is null then the
range is empty and no filing will occur.
If lockExtent is true then an extent lock will be acquired before the indices
are built. If the lock cannot be acquired then an error is returned. The lock is released
after the index filing is completed.
Returns a %Status value indicating success or failure.