Skip to main content


serial class SYS.History.Database extends %Library.SerialObject

A list of Database properties for the SysData interval collection class

For details, see History Monitor.

Property Inventory

Method Inventory


property FileSize as %Numeric;
Size of each database file (in MB)
Property methods: FileSizeDisplayToLogical(), FileSizeGet(), FileSizeIsValid(), FileSizeLogicalToDisplay(), FileSizeNormalize(), FileSizeSet()
property FreeSpace as %Numeric;
Freespace available in each database file (in MB)
NOTE: this value is fetched from the %Monitor.System.Freespace class samples, so that must be "active" or this will be blank.
Property methods: FreeSpaceDisplayToLogical(), FreeSpaceGet(), FreeSpaceIsValid(), FreeSpaceLogicalToDisplay(), FreeSpaceNormalize(), FreeSpaceSet()


classmethod SetSummary(ByRef Function As %String, Period As %String) as %Status
Configure the summary methods for this class for either the Hourly or Daily summaries. This is a comma-delimited list of functions to use for the summary. The available functions are Average, Maximum (high-water mark), Minimum (lowest value), Standard Deviation, Median, and Total. These are abbreviated in the 'Function' argument as "Avg", "Max", "Min", StDev", Med", and "Tot". If nothing is specified, the default is "Avg,Max,StDev". You may also specify the string "None" for a summary period to disable that summary.

A null 'Function' argument will return the current summary setting in the 'Function' variable.

The 'Period' argument can be either "Hourly" or "Daily".

Inherited Members

Inherited Methods

FeedbackOpens in a new tab