Loading TOC...

admin.databaseMonthlyBackup

admin.databaseMonthlyBackup(
   $backup-dir as String,
   $backup-period as Number,
   $backup-month-day as (Number|String),
   $start-time as (Number|String),
   $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 monthly scheduled backup specification.

Parameters
$backup-dir The directory where the backup will be saved to.
$backup-period The number of months to elapse between each backup.
$backup-month-day The day of the month the backup will happen (between 1 and 31)
$start-time A time for the scheduled backup to start.
$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.databaseMonthlyBackup("/backupDir", 2, 1,
        xs.time("09:45:00"),10,"true","true","true")

   //returns the monthly backup specification 
  

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  admin.databaseMonthlyBackup("/backupDir", 2, 1,
        xs.time("09:45:00"),10,"true","true","true","false","true",[],500)

   //returns the monthly//backup specification 
  

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