Class %Storage.Shard

class %Storage.Shard extends %Storage

This class contains a set of storage interface methods for use in sharded environments. It is not for customer use.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2		9

Summary

Methods
%BuildDeferredIndices	%BuildIndices	%LockExtent	%PurgeIndices
%ShardKey	%UnlockExtent	%ValidateIndices	%ValidateTable

Parameters

• parameter STORAGECOMPILERCLASS = "%Compiler.Storage.Persistent";

• parameter STORAGEINTERFACE = "persistent";

STORAGEINTERFACE defines the type of serialization implemented by this class. The value has to match the classtype of the class that is inheriting the serialization interface.

Methods

• classmethod %BuildDeferredIndices(pLockFlag As %Integer = 0, pJournalFlag As %Integer = 1) as %Status

Intercept calls to %BuildDeferredIndices and cause them to be executed on all the shards

• classmethod %BuildIndices(pIndexList As %RawString = "", pAutoPurge As %Integer = 1, pLockFlag As %Integer = 0, pJournalFlag As %Integer = "", pStartID As %RawString = "", pEndID As %RawString = "", pIgnoreIndexList As %RawString = "", pKeepSelectability As %Integer = 0) as %Status

Intercept calls to %BuildIndices and cause them to be executed on all the shards

• classmethod %LockExtent(shared As %Boolean = 0) as %Status

%LockExtent acquires a lock on the entire extent of the class. If shared is true then a shared lock is acquired, otherwise an exclusive lock is acquired. If the requested lock cannot be acquired then a failure %Status value is returned. The default implementation returns an error indicating that the method is not implemented. This method is automatically generated for persistent classes using %Storage.Persistent or %Storage.SQL.

• classmethod %PurgeIndices(idxlist As %List = "", lockExtent As %Boolean = 0, pIgnoreIndexList As %RawString = "") as %Status

Intercept calls to %PurgeIndices and cause them to be executed on all the shards

• abstract classmethod %ShardKey(args... As %String) as %String

Generate the shard key from the fields that make up the key. Not used currently.

• classmethod %UnlockExtent(shared As %Boolean = 0, immediate As %Boolean = 0) as %Status

%UnlockExtent releases a lock on the entire extent of the class. If shared is true then a shared lock is acquired, otherwise an exclusive lock is acquired. If the requested lock cannot be acquired then a failure %Status value is returned. The default implementation returns an error indicating that the method is not implemented. This method is automatically generated for persistent classes using %Storage.Persistent or %Storage.SQL.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search