%SYS
wsDatabase Class Reference

Information about databases used by a InterSystems IRIS instance. More...

Inheritance diagram for wsDatabase:
Collaboration diagram for wsDatabase:

Static Public Member Functions

_.Library.Status ListClose (_.Library.Binary qHandle)
 Information about databases used by a InterSystems IRIS instance. More...
 
SYS.WSMon.wsDatabase Sample (index)
 Instantiate the class and fill in current values for all properties. More...
 

Public Attributes

 Cluster
 An indicator whether this database is monted with cluster access. More...
 
 Directory
 The path and file name of of the database. More...
 
 FreeSpace
 The available space (in MB) in this database. More...
 
 Mounted
 An indicator whether this database is currently mounted. More...
 
 Name
 The name given to the database. More...
 
 ReadOnly
 An indicator whether this database is mounted with only read access. More...
 
 SizeAllocated
 The amount of disk space (in MB) allocated for this database. More...
 

Detailed Description

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.

Member Function Documentation

◆ ListClose()

_.Library.Status ListClose ( _.Library.Binary  qHandle)
static

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.

◆ Sample()

SYS.WSMon.wsDatabase Sample (   index)
static

Instantiate the class and fill in current values for all properties.

'index' is an integer index into the database list.

Member Data Documentation

◆ Cluster

An indicator whether this database is monted with cluster access.

 

◆ Directory

Directory

The path and file name of of the database.

 

◆ FreeSpace

FreeSpace

The available space (in MB) in this database.

Note that the Monitor FreeSpace property must be active.  

◆ Mounted

Mounted

An indicator whether this database is currently mounted.

 

◆ Name

Name

The name given to the database.

 

◆ ReadOnly

ReadOnly

An indicator whether this database is mounted with only read access.

 

◆ SizeAllocated

SizeAllocated

The amount of disk space (in MB) allocated for this database.