MarkLogic 9 Product Documentation
xdmp:forest-backup

xdmp:forest-backup(
   $forestID as xs:unsignedLong,
   $pathname as xs:string
) as empty-sequence()

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.

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}

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

xdmp:forest-backup(11183608861595735720,"/backups/Data/Forests/Documents")
=> ()

MarkLogic 9 Product Documentationxdmp:forest-backup