Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [SYS] >  [WSMon] >  [wsDatabase]
Private  Storage   

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

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 4 1


Summary

Properties
Cluster Directory FreeSpace Mounted Name
ReadOnly SizeAllocated

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
ListClose ListExecute ListFetch Sample
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


Properties

• property Cluster as %Boolean;
An indicator whether this database is monted with cluster access.
• property Directory as %String;
The path and file name of of the database.
• property FreeSpace as %Integer;
The available space (in MB) in this database. Note that the %Monitor FreeSpace property must be active.
• property Mounted as %Boolean;
An indicator whether this database is currently mounted.
• property Name as %String;
The name given to the database
• property ReadOnly as %Boolean;
An indicator whether this database is mounted with only read access.
• property SizeAllocated as %Integer;
The amount of disk space (in MB) allocated for this database.

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


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.