MarkLogic 12 Product Documentation

xdmp.forestBackupStatus

xdmp.forestBackupStatus(
   forestid as (Number|String)[]
) as ObjectNode*

Summary

Checks the status of the specified forests for any outstanding backup jobs. Returns the specified forests portion a database backup status as a JSON node.

Required Privileges

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

Usage Notes

The structure of the data returned is as follows:

forestName

The name of the forest.

forestId

The ID of the forest.

forestStatus

The status of the forest.

directoryPath

The directory path.

directoryStatus

The status of the directory where the backup is located.

backupTime

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.

restoreToTime

Restore the back up to this time.

journalArchiving

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

journalArchivePath

Path to the location of the journal archive.

journalArchivePathStatus

Status of the journal archive path.

journalsStatus

Status of the journals.

forestUpdate

Forest update.

forestUpdateStatus

Status of the forest update.

journalArchiveLagLimit

Integer describing the journal archive lag limit.

journalArchiveLagLimitStatus

Status of the journal archive lag limit.

mergeTimestampStatus

Status of the merge timestamp.

incrementalBackup

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

incrementalBackupPath

Path to the location of the incremental back up.

incrementalBackupPathStatus

Status of the incremental back up path.

fullBackupStatus

Status of the full backup.

backupForests

This is an object with the following properties:

backupForest

This is an object with the following properties:

forestName

The name of the forest.

directoryStatus

The status of the directory where the backup is located.

Example

xdmp.forestBackupStatus(xdmp.forest("My-Forest"));
=>
{
  "jobId":"1261339155818839957",
  "forests":
  {
   "forestName":"bill",
   "forestId":"7201957734358937355",
   "status":"completed",
   "incrementalBackup":"false",
   "journalArchiving":"false"
   }
}