MarkLogic 10 Product Documentation
xdmp:start-journal-archiving

xdmp:start-journal-archiving(
   $forestIDs as xs:unsignedLong*,
   $journal-archive-path as xs:string,
   [$lag-limit as xs:unsignedLong?]
) as empty-sequence()

Summary

Starts journal archiving to the specified list of forests.

Parameters
forestIDs	A sequence of forest IDs.
journal-archive-path	Path to where archived journals are stored. Defaults to the backup data directory.
lag-limit	Maximum difference in seconds that the archived journal can lag behind its forest's active journal. Defaults to 15.

Required Privileges

This operation requires at least one of the following privileges:

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

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

Example

xdmp:start-journal-archiving(
xdmp:database-forests(xdmp:database("Documents")),"/backups/Data",500)

MarkLogic 10 Product Documentationxdmp:start-journal-archiving

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
xdmp:start-journal-archiving