xdmp:database-restore
xdmp:database-restore(
$forestIDs as xs:unsignedLong*,
$pathname as xs:string,
[$restoreToTime as xs:dateTime?],
[$journal-archiving as xs:boolean?],
[$journal-archive-path as xs:string?],
[$incremental-backup as xs:boolean?],
[$incremental-backup-path as xs:string?]
) as xs:unsignedLong
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.
|
Required Privileges
http://marklogic.com/xdmp/privileges/xdmp-database-restore
Usage Notes
Reindexing will stop while a backup or restore is in progress.
Example
xdmp:database-restore((11183608861595735720,898513504988507762),
"/backups/Data")
=> 33030877979801813489
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.