Loading TOC...
JavaScript admin.databaseOneTimeBackup

MarkLogic 9 Product Documentation
admin:database-one-time-backup

admin:database-one-time-backup(
   $backup-dir as xs:string,
   $start as xs:dateTime,
   $max-backups as xs:unsignedLong,
   $backup-security-db as xs:boolean,
   $backup-schemas-db as xs:boolean,
   $backup-triggers-db as xs:boolean,
   [$include-replicas as xs:boolean],
   [$journal-archiving as xs:boolean?],
   [$journal-archive-path as xs:string?],
   [$lag-limit as xs:unsignedLong?]
) as element(db:database-backup)

Summary

This function constructs a one-time backup specification.

Parameters
backup-dir The directory where the backup will be saved to.
start The starting dateTime of the scheduled backup.
max-backups The maximum number of backups to keep in the backup directory.
backup-security-db Whether to backup the security database alongside the current backup.
backup-schemas-db Whether to backup the schemas database alongside the current backup.
backup-triggers-db Whether to backup the triggers database alongside the current backup.
include-replicas If set to false, do not include the replicas in the backup. The default is true, which means to include all replicas in the backup.
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.

Example


  xquery version "1.0-ml";

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

  admin:database-one-time-backup("/backup-dir",
        xs:dateTime("2008-02-14T09:45:00"),10,true(),true(),true())
  (: returns the one-time backup :)

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