This class is used internally by InterSystems IRIS. More...

Inheritance diagram for BackgroundTask:

[legend]

Collaboration diagram for BackgroundTask:

[legend]

Static Public Member Functions
_.Library.Status	AssignShard (pParms)
	Assign new shard in the background.

_.Library.Status	AuditCopy (pParms)
	Start Copy audit log to another namespace.

_.Library.Status	AuditExport (pParms)
	Start Export audit log.

_.Library.Status	AuditPurge (pParms)
	Start Purge audit log.

_.Library.Status	CompactDBSpace (pParms)
	Return unused db space.

_.Library.Status	Compile (pParms, tItems)
	Start Compile routines/classes.

_.Library.Status	CopyNamespaceMappings (pParms)
	Copy Mappings from one Namespace to another.

_.Library.Status	CreateDatabase (pParms)
	Create a database.

_.Library.Status	DataMigration (pParms, tItems)
	Sart SQL Data Migration.

_.Library.Status	DatabaseIntegrityCheck (pParms)
	Start database file integrity check. More...

_.Library.Status	Delete (pParms, tItems)
	Start Delete routines/classes.

_.Library.Status	EnableEnsNamespace (pParms)
	Enable productions for a namespace.

_.Library.Status	Export (pParms, tItems)
	Start Export globals/routines/classes.

_.Library.Status	ExternalLangServers (pParms)
	Check status of external language servers.

_.Library.Status	FileMan (pParms, pItems)
	Map FileMan files to InterSystems classes.

_.Library.Status	Import (pParms, tItems)
	Start Import globals/routines/classes.

_.Library.Status	JobComparePlans (pParms)
	Run Compare Show Plans process in the background.

_.Library.Status	JobPossiblePlans (pParms)
	Run Possible Plans process in the background.

_.Library.Status	JobSaveQuery (pParms)
	Run Save Query (for pTools) process in the background.

_.Library.Status	JobShowPlan (pParms)
	Run Show Plan process in the background.

_.Library.Status	JournalIntegrityCheck (pParms)
	Start journal file integrity check.

_.Library.Status	LinkProcedure (pParms, tItems)
	Start SQL Link Procedure.

_.Library.Status	LinkTable (pParms, tItems)
	Start SQL Link Table.

_.Library.Status	MirrorActivateCatchupDB (pParms, pItems)
	Activate and/or catchup Mirror DBs.

_.Library.Status	MirrorAddDatabases (pParms, pItems)
	Add databases to mirror.

_.Library.Status	MirrorMountDB (pParms, pItems)
	Mount Mirror DBs.

_.Library.Status	MirrorRemoveDB (pParms, pItems)
	Remove DBs from mirror.

_.Library.Status	ModifyDatabaseSize (pParms)
	Modify database size.

_.Library.Status	PurgeAllCachedQueries ()
	Purge all cached queries from all namespaces.

_.Library.Status	QueryExport (pParms)
	Start SQL Export Dynamic Query.

_.Library.Status	RebalanceShard (pParms)
	Rebalance shards in the background.

_.Library.Status	RebuildIndices (pParms)
	Rebuild indices for a class.

	RunBackgroundTask (_.Library.String pTask, _.Library.String pNS, _.Library.List pParmList, _.Library.Integer pIdx)
	This wrapper method is run in the background job. More...

_.Library.Status	RunTask (_.Library.String pTask, _.Library.String pNS, _.Library.String pParms, _.Library.String tItems, _.Library.Integer pJob)
	Use this method to request a background task. More...

_.Library.Status	SQLExport (pParms)
	Start SQL Export.

_.Library.Status	SQLImport (pParms)
	Start SQL Import.

_.Library.Status	Task1 (pParms)
	Test task.

_.Library.Status	TuneTables (pParms)
	Tune all tables in a schema.

_.Library.Status	VerifyShard (pParms)
	Verify shards in the background.

	WriteDone ()
	This method writes generic Status of "Done".

	WriteError (ErrorMessage)
	This method writes generic Status of "ERROR" and error message to Details.

Static Public Attributes
	DOMAIN = None
	This class is used internally by InterSystems IRIS. More...

	TASKS = None
	This defines the allowed tasks that this class can run.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

This class is used internally by InterSystems IRIS.

You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

This class supplies the ManagementPortal with a way to execute certain tasks as background jobs.
For example, you can rebuild indices for a class:

Set tParms("ClassName") = "Sample.Person" Set tSC = ..RunTask("RebuildIndices","SAMPLES",.tParms,.tJob)

Member Function Documentation

◆ DatabaseIntegrityCheck()

_.Library.Status DatabaseIntegrityCheck ( pParms )

static

Start database file integrity check.

After finish, transform results to file.

◆ RunBackgroundTask()

RunBackgroundTask	(	_.Library.String	pTask,
		_.Library.String	pNS,
		_.Library.List	pParmList,
		_.Library.Integer	pIdx
	)

static

This wrapper method is run in the background job.

pParms is a list of parameters.

◆ RunTask()

_.Library.Status RunTask	(	_.Library.String	pTask,
		_.Library.String	pNS,
		_.Library.String	pParms,
		_.Library.String	tItems,
		_.Library.Integer	pJob
	)

static

Use this method to request a background task.

pTask is name of task to run; it must one of the entries in the TASKS parameter.
pNS is namespace to run task in.
pParms is a array containing parameters for the task in the form pParms(parm)=value.
It returns a PID# if the task is started, or 0 if it fails to start.

Member Data Documentation

◆ DOMAIN

DOMAIN = None

static

This class is used internally by InterSystems IRIS.

You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

This class supplies the ManagementPortal with a way to execute certain tasks as background jobs.
For example, you can rebuild indices for a class:

Set tParms("ClassName") = "Sample.Person" Set tSC = ..RunTask("RebuildIndices","SAMPLES",.tParms,.tJob)

Default Localization Domain

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DatabaseIntegrityCheck()

◆ RunBackgroundTask()

◆ RunTask()

Member Data Documentation

◆ DOMAIN