Loading TOC...

xdmp.databaseBackupCancel

xdmp.databaseBackupCancel(
   $jobid as String
) as Boolean

Summary

Cancels an outstanding backup job with the specified job ID, returning true if the cancel operation is successful, false if the cancel operation is not successful. The xdmp:database-backup-cancel function must be run on the host in which the backup was initiated.

Parameters
$jobid A backup job ID. You can find the job IDs for running backups by calling xdmp:host-status and looking in the <host-status:backup-jobs> element (where the host-status prefix is bound to the http://marklogic.com/xdmp/status/host namespace).

Required Privileges

http://marklogic.com/xdmp/privileges/xdmp-database-backup-cancel

Example

xdmp.databaseBackupCancel(3303087797980181348)
=> true

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy