Loading TOC...


   backup-dir as xs:string,
   backup-period as xs:positiveInteger,
   start-minute as xs:nonNegativeInteger,
   backup-security-db as xs:boolean,
   backup-schemas-db as xs:boolean,
   backup-triggers-db as xs:boolean,
   [include-replicas as xs:boolean],
   [incremental-dir as xs:string?],
   [purge-journal-archive as xs:boolean?],
   [journal-archiving as xs:boolean?],
   [journal-archive-path as xs:string?],
   [lag-limit as xs:unsignedLong?]
) as element(db:database-backup)


This function constructs an hourly scheduled incremental database backup specification.

backup-dir The directory where the full backup is located.
backup-period The number of hours to elapse between each incremental backup.
start-minute The number of minutes after the hour to start the incremental backup. Note that this setting does not add to the incremental backup period value.
backup-security-db Whether to backup the security database alongside the current incremental backup.
backup-schemas-db Whether to backup the schemas database alongside the current incremental backup.
backup-triggers-db Whether to backup the triggers database alongside the current incremental backup.
include-replicas If set to false, do not include the replicas in the incremental backup. The default is true, which means to include all replicas in the backup.
incremental-dir The directory in which to save the incremental backup.
purge-journal-archive Whether or not to purge journal archive after incremental backup is performed. Defaults to false
journal-archiving Whether or not to enable journal archiving. Defaults to false.
journal-archive-path Path for 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 900.


xquery version "1.0-ml";

import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

admin:database-hourly-incremental-backup("/backup-dir", 2, 5,


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