This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %SYS.ClusterInfo extends %Library.RegisteredObject

Cluster-specific Information

Method Inventory (Including Private)


classmethod IsMaster() as %Boolean
True when this system is the cluster master
classmethod IsMember() as %Boolean
Is the system part of a cluster or not
classmethod MasterNodeName() as %String
Return node name of the current master in the cluster.
Returned null string if this system is not a cluster member.
classmethod NodeListClose(ByRef qHandle As %Binary) as %Status
classmethod NodeListExecute(ByRef qHandle As %Binary, SkipSelf As %Boolean = 0) as %Status
classmethod NodeListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status


query NodeList(SkipSelf As %Boolean = 0)
Selects CSN As %Integer, IP As %String, Port As %Integer, MGR Dir As %String, Journal Offset As %Integer, Journal File As %String, Journal File Count As %Integer, Transaction Offset As %Integer, Transaction File As %String, Transaction File Count As %Integer, Host Name As %String, Prev Journal Offset As %Integer, Prev Journal File Count As %Integer, Prev Journal File As %String, Journal WDPass As %Integer
Returns information about member nodes of the cluster using DNS resolution of the members' hostnames. If SkipSelf = 1, skip the node where the query is run

Inherited Members

Inherited Methods (Including Private)