SYS.WSMon.wsDatabase
Class SYS.WSMon.wsDatabase Extends SYS.WSMon.wsResource [ System = 4 ]
Information about databases used by a InterSystems IRIS instance. The List() query is used by the SYS.WSMon.Service.EnumDatabase() Web method, to provide details on all databases. The Sample() method can be used to Get information about a specific database.
Properties
Name
Property Name As %String;
The name given to the database
Directory
Property Directory As %String;
The path and file name of of the database.
SizeAllocated
Property SizeAllocated As %Integer;
The amount of disk space (in MB) allocated for this database.
Mounted
Property Mounted As %Boolean;
An indicator whether this database is currently mounted.
ReadOnly
Property ReadOnly As %Boolean;
An indicator whether this database is mounted with only read access.
Cluster
Property Cluster As %Boolean;
An indicator whether this database is monted with cluster access.
FreeSpace
Property FreeSpace As %Integer;
The available space (in MB) in this database. Note that the %Monitor FreeSpace property must be active.
Methods
ListExecute
ClassMethod ListExecute(ByRef qHandle As %Binary) As %Status
Sample counters for all Databases
ListClose
ClassMethod ListClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = SampleExecute ]
ListFetch
ClassMethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = SampleExecute ]
Sample
ClassMethod Sample(index) As SYS.WSMon.wsDatabase
Instantiate the class and fill in current values for all properties. 'index' is an integer index into the database list.