MarkLogic Server 11.0 Product Documentation

xdmp.databaseRestoreStatus

xdmp.databaseRestoreStatus(
   jobid as (Number|String)
) as Object

Summary

Checks the status of the outstanding restore job with the specified job ID. Returns a database restore status Object.

Required Privileges

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

Example

xdmp.databaseRestoreStatus(
  xdmp.databaseRestore(
    xdmp.databaseForests(
      xdmp.database("Documents")),
    "/space/backup"
    )
  );
=>
{
  "status": "in-progress",
  "forests": [
    {
      "forestName": "Documents",
      "forestId": "15810433344251984001",
      "status": "in-progress",
      "journalArchiving": false
    }
  ]
}