Cleanup Job Parameters

Getting and Setting Cleanup Job Parameters

CleanUp job parameters define the conditions used to identify entries to be deleted (their age and usage frequency). These parameters can be viewed and set using the getJobProperty and setJobProperty procedures, respectively.

Getting a Cleanup Job Parameter

SQL

CALL "SYSADMIN.getJobProperty"(
    "jobid" => 2,
     "propertyName" => 'CALENDAR_FIELD_VALUE'
) ;;

Setting a Cleanup Job Parameter

SQL

CALL "SYSADMIN.setJobProperty"( 
	"jobuUid" => 'aa9dc4e2-bd98-11f0-8b66-8c3b4a5925c8', 
	"propertyName" => 'CALENDAR_FIELD_VALUE', 
	"propertyValue" => '-17'
) ;;

Parameters

Both procedures take the following parameters:

Parameter	Description
`jobid`	ID of the job; ID or UUID should be set
`CALENDAR_FIELD_TYPE`	Specifies the time measurement unit that is used to determine whether the entry is old enough to be deleted; at the moment, only the `DAY_OF_MONTH` calendar field type is supported
`CALENDAR_FIELD_VALUE`	Specifies the value of the time interval that is used to determine whether the entry is old enough to be deleted; default: `14`; mandatory for `getJobProperty`
`FREQUENCY`	Applicable to optimizations; specifies optimisation usage frequency (optimizations with lower usage frequency are subject to deletion); default: `15`
`jobUuid`	UUID of the job; ID or UUID should be set

The jobUuid parameter for the SYSADMIN.setJobProperty and SYSADMIN.getJobProperty procedures is available since v25.4

List of Cleanup Jobs Supporting and Not Supporting Parameters

Not all Cleanup jobs support these parameters; they are valid for the following:

Clean finished job logs task
Clean finished query logs task
Clean old and never materialized before optimizations task
Clean old histories task
Clean performance metrics task

These parameters are not supported for the following tasks:

Clean invalid indexes task
Clean stale replicator tables task