Loading TOC...

xdmp.forestBackup

xdmp.forestBackup(
   $forestID as String,
   $pathname as String
) as null

Summary

Backs up forest data files.

Parameters
$forestID A forest ID.
$pathname A forest backup pathname. If the directory does not exist, it is created when you run this function. The filesystem permissions must be such that the directory is writable by the operating system user under which MarkLogic Server is running. The directory cannot be the MarkLogic Server install directory or the MarkLogic Server data directory.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/xdmp-forest-backup

http://marklogic.com/xdmp/privileges/xdmp-forest-backup/forest/{id}

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

Usage Notes

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

Example

xdmp.forestBackup(xdmp.forest("Documents"),"/space/backups");
=> ()

Comments

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