MarkLogic 12 Product Documentation

xdmp:forest-backup-status

xdmp:forest-backup-status(
   $forestid as xs:unsignedLong*
) as element()*

Summary

Checks the status of the specified forests for any outstanding backup jobs. Returns the specified forests portion a database backup status node defined in the job-status.xsd schema.

Required Privileges

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

Usage Notes

The structure of the data returned is as follows:

forest-name

The name of the forest.

forest-id

The ID of the forest.

forest-status

The status of the forest.

directory-path

The directory path.

directory-status

The status of the directory where the backup is located.

backup-time

Backup time extracted from path name.

action

Action to be taken by the backup plan. The action can be "backup", "incremental-backup" or "restore" depending on the plan.

restore-to-time

Restore the back up to this time.

journal-archiving

Whether journal archiving is enabled (true or false). Default is false.

journal-archive-path

Path to the location of the journal archive.

journal-archive-path-status

Status of the journal archive path.

journals-status

Status of the journals.

forest-update

Forest update.

forest-update-status

Status of the forest update.

journal-archive-lag-limit

Integer describing the journal archive lag limit.

journal-archive-lag-limit-status

Status of the journal archive lag limit.

merge-timestamp-status

Status of the merge timestamp.

incremental-backup

Whether an incremental back up occurred (true or false). Default is false.

incremental-backup-path

Path to the location of the incremental back up.

incremental-backup-path-status

Status of the incremental back up path.

full-backup-status

Status of the full backup.

backup-forests

This is a complex element with the following element children:

backup-forest

This is a complex element with the following element children:

forest-name

The name of the forest.

directory-status

The status of the directory where the backup is located.

Example

xdmp:forest-backup-status((33030877979801813489, 16529920850295602277))
=>
<job:job-status xsi:schemaLocation="http://marklogic.com/xdmp/job-status
   job-status.xsd" xmlns:job="http://marklogic.com/xdmp/job-status"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <job:forest>
    <job:forest-name>Documents</job:forest-name>
    <job:forest-id>9157142760003704384</job:forest-id>
    <job:status>in-progress</job:status>
    <job:journal-archiving>true</job:journal-archiving>
    <job:journal-archive-path>/backup/JournalArchive</job:journal-archive-path>
    <job:journal-archive-lag-limit>15</job:journal-archive-lag-limit>
  </job:forest>
</job:job-status>