Loading TOC...
XQuery xdmp:start-journal-archiving

MarkLogic 9 Product Documentation
xdmp.startJournalArchiving

xdmp.startJournalArchiving(
   forestIDs as (Number|String)[],
   journal-archive-path as String,
   [lag-limit as (Number|String)?]
) as null

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.startJournalArchiving(
    xdmp.databaseForests(xdmp.database("Documents")),"/backups/Data",500);

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.