<?xml version="1.0" encoding="UTF-8"?><api:function-page xml:base="/apidoc/8.0/xdmp.forestBackup.xml" generated="2015-10-07T16:36:00.016766-07:00" mode="javascript" xmlns:api="http://marklogic.com/rundmc/api"><api:function-name>xdmp.forestBackup</api:function-name><api:suggest>xdmp.forestbackup</api:suggest><api:suggest>xdmp</api:suggest><api:suggest>forestbackup</api:suggest><api:function-link mode="xquery" fullname="xdmp:forest-backup">/apidoc/8.0/xdmp:forest-backup.xml</api:function-link><api:function mode="javascript" name="forestBackup" type="builtin" lib="xdmp" category="AdminBuiltins" hidden="false" bucket="MarkLogic Built-In Functions" prefix="xdmp" namespace="http://marklogic.com/xdmp" fullname="xdmp.forestBackup"><api:summary>
  Backs up forest data files.
</api:summary><api:params><api:param name="forestID" type="xs:unsignedLong"><api:param-description>
    A forest ID.
  </api:param-description><api:param-name>forestID</api:param-name><api:param-type>String</api:param-type></api:param><api:param name="pathname" type="xs:string"><api:param-description>
    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.
  </api:param-description><api:param-name>pathname</api:param-name><api:param-type>String</api:param-type></api:param></api:params><api:return>null</api:return><api:privilege>
  <p xmlns="http://www.w3.org/1999/xhtml"><code>http://marklogic.com/xdmp/privileges/xdmp-forest-backup</code></p>
</api:privilege><api:usage>
  <p xmlns="http://www.w3.org/1999/xhtml">Reindexing will stop while a backup or restore is in progress. </p>
</api:usage><api:example class="javascript"><pre xml:space="preserve" xmlns="http://www.w3.org/1999/xhtml">
xdmp.forestBackup(xdmp.forest("Documents"),"/space/backups");
=&gt; ()
</pre></api:example></api:function></api:function-page>