Loading TOC...
XQuery admin:database-one-time-backup

MarkLogic 10 Product Documentation
admin.databaseOneTimeBackup

admin.databaseOneTimeBackup(
   backup-dir as String,
   start as Date,
   max-backups as (Number|String),
   backup-security-db as Boolean,
   backup-schemas-db as Boolean,
   backup-triggers-db as Boolean,
   [include-replicas as Boolean],
   [journal-archiving as Boolean?],
   [journal-archive-path as String?],
   [lag-limit as (Number|String)?]
) as element(db.databaseBackup)

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

  
  const admin = require('/MarkLogic/admin.xqy');
  admin.databaseOneTimeBackup("/backupDir",
        xs.dateTime("2008-02-14T09:45:00"),10,"true","true","true")

   //returns the oneTime backup

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