This is documentation for Caché & Ensemble.

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).

Home > Class Reference > %SYS namespace > SYS.WSMon.wsDatabase

SYS.WSMon.wsDatabase

class SYS.WSMon.wsDatabase extends SYS.WSMon.wsResource

Information about databases used by a Cache 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.

Property Inventory

Method Inventory

Properties

property Cluster as %Boolean;
An indicator whether this database is monted with cluster access.
Property methods: ClusterDisplayToLogical(), ClusterGet(), ClusterIsValid(), ClusterLogicalToDisplay(), ClusterLogicalToXSD(), ClusterNormalize(), ClusterSet(), ClusterXSDToLogical()
property Directory as %String;
The path and file name of of the database.
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property FreeSpace as %Integer;
The available space (in MB) in this database. Note that the %Monitor FreeSpace property in Cache must be active.
Property methods: FreeSpaceDisplayToLogical(), FreeSpaceGet(), FreeSpaceIsValid(), FreeSpaceLogicalToDisplay(), FreeSpaceNormalize(), FreeSpaceSet(), FreeSpaceXSDToLogical()
property Mounted as %Boolean;
An indicator whether this database is currently mounted.
Property methods: MountedDisplayToLogical(), MountedGet(), MountedIsValid(), MountedLogicalToDisplay(), MountedLogicalToXSD(), MountedNormalize(), MountedSet(), MountedXSDToLogical()
property Name as %String;
The name given to the Cache database
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property ReadOnly as %Boolean;
An indicator whether this database is mounted with only read access.
Property methods: ReadOnlyDisplayToLogical(), ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlyLogicalToDisplay(), ReadOnlyLogicalToXSD(), ReadOnlyNormalize(), ReadOnlySet(), ReadOnlyXSDToLogical()
property SizeAllocated as %Integer;
The amount of disk space (in MB) allocated for this database.
Property methods: SizeAllocatedDisplayToLogical(), SizeAllocatedGet(), SizeAllocatedIsValid(), SizeAllocatedLogicalToDisplay(), SizeAllocatedNormalize(), SizeAllocatedSet(), SizeAllocatedXSDToLogical()

Methods

classmethod ListClose(ByRef qHandle As %Binary) as %Status
classmethod ListExecute(ByRef qHandle As %Binary) as %Status
classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
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.

Queries

query List()
Selects Name As %String, Directory As %String, SizeAllocated As %Integer, Mounted As %Boolean, ReadOnly As %Boolean, Cluster As %Boolean, FreeSpace As %Integer
Sample counters for all Databases

Inherited Members

Inherited Methods

Feedback