Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [SYS] >  [Database] >  [BackgroundDefragment]
Private  Storage   

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

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 1


Summary

Properties
CancelIsAvailable Class Database DisplayType
FinalStatus HasEnded Namespace PID
PauseIsAvailable ProgressCurrent ProgressTotal ProgressUnits
Request ResumeIsAvailable RunningState StartTime

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject Cancel
Pause Resume Start


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 %String;
Database directory on which to operate

Queries

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


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