admin.forestHourlyBackup

admin.forestHourlyBackup(
   backup-dir as String,
   backup-period as Number,
   start-minute as xs.nonNegativeInteger
) as element(as.forestBackup)

Summary

This function constructs a hourly scheduled forest backup specification.

Parameters
backup-dir The directory to save the backup.
backup-period The number of hours to elapse between each backup
start-minute The number of minutes after the hour to start the backup. Note that this setting does not add to the backup period value.

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
    admin.forestHourlyBackup("/backupDir", 2, 30)

   //returns the hourly forest backup specification. For example, if the
   //current time is 2.15pm, the backup will run at 4.30pm, 6.30pm, 8.30pm,
   //and so on. 
   
Powered by MarkLogic Server | Terms of Use | Privacy Policy