SYS.Database.BackgroundDefragment

persistent class SYS.Database.BackgroundDefragment extends %SYS.BackgroundTask

SQL Table Name: SYS_Database.BackgroundDefragment

Class to start, monitor and control the Database Defragmentation utiltity running in the background. The method run in the background is the Defragment method of SYS.Database.

To start it

	set oref=##class(SYS.Database.BackgroundDefragment).Start(Directory)
See the FileCompact method of SYS.Database for description of the parameters above.

Start() returns an oref to an object of this class that can be inspected and reloaded to get status and progress updates. See superclass %SYS.BackgroundTask for detailed information on features of this object.

Property Inventory

Parameters

parameter CANCELDISPOSITION = -1;
Disposition for cancel requests.

0 - not allowed
1 - polls for cancel requests
-1 - directly terminate the process

Properties

property Database as %SysPath;
Database directory on which to operate
Property methods: DatabaseDisplayToLogical(), DatabaseGet(), DatabaseGetStored(), DatabaseIsValid(), DatabaseListClose(), DatabaseListExecute(), DatabaseListFetch(), DatabaseListFetchRows(), DatabaseListFunc(), DatabaseListGetInfo(), DatabaseListGetODBCInfo(), DatabaseListPrepare(), DatabaseListSendODBC(), DatabaseLogicalToDisplay(), DatabaseLogicalToOdbc(), DatabaseNormalize(), DatabaseSet()

Queries

query List()
SQL Query:
SELECT %ID,StartTime,Database,RunningState,HasEnded,FinalStatus,ProgressCurrent,ProgressTotal,ProgressUnits FROM SYS_Database.BackgroundDefragment

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%SYS.BackgroundTask)

^%SYS.BackgroundTaskD(ID)
=
%%CLASSNAME
StartTime
Namespace
FinalStatus
PID
MemIdx
Version
JobNum
JobID
ExternalStateStored

Storage Model: Storage (SYS.Database.BackgroundDefragment)

^%SYS.BackgroundTaskD(ID,"DatabaseDefragment")
=
Database
Feedback