MarkLogic 9 Product Documentationxdmp.databaseBackupCancel
xdmp.databaseBackupCancel( jobid as (Number|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
This operation requires at least one of the following privileges:http://marklogic.com/xdmp/privileges/xdmp-database-backup-cancel
http://marklogic.com/xdmp/privileges/xdmp-database-backup-cancel/database/{id}
Example
xdmp.databaseBackupCancel(3303087797980181348) => true