Loading TOC...

xdmp.databaseRestore

xdmp.databaseRestore(
   $forestIDs as String[],
   $pathname as String,
   [$restoreToTime as Date?],
   [$journal-archiving as Boolean?],
   [$journal-archive-path as String?],
   [$incremental-backup as Boolean?],
   [$incremental-backup-path as String?],
   [$backup-passphrase as String?]
) as String

Summary

Starts an asynchronous restore of the specified list of forests from the backup data directory. Returns a job ID that uniquely identifies the restore task.

Parameters
$forestIDs A sequence of forest IDs.
$pathname A backup data directory pathname.
$restoreToTime The date and time to restore the forest data to.
$journal-archiving Whether to restore from archived journals. Defaults to false.
$journal-archive-path Path to where archived journals are stored. Defaults to the backup data directory.
$incremental-backup Whether to restore using incremental backups. Defaults to false.
$incremental-backup-path Path to where incremental backups are stored. Defaults to the backup data directory.
$backup-passphrase An additional backup passphrase that can be used to restore from backup.

Required Privileges

This operation requires at least one of the following privileges:

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

http://marklogic.com/xdmp/privileges/xdmp-database-restore/database/{id}

Usage Notes

Reindexing will stop while a backup or restore is in progress.

Example

xdmp.databaseRestore([11183608861595735720,898513504988507762],
    "/backups/Data")
=> 33030877979801813489

Comments

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