
MarkLogic 10 Product Documentation
admin.forestMonthlyBackupadmin.forestMonthlyBackup(
   backup-dir as String,
   backup-period as Number,
   backup-month-day as Number,
   start-time as (Number|String)
) as element(as.forestBackup)
Summary
      This function constructs a monthly scheduled backup.
    
	  
	  
	
	  
	    | 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.
       | 
	  
	
Example
  
  const admin = require('/MarkLogic/admin.xqy');
  admin.forestMonthlyBackup("/backupDir", 1, 1, xs.time("09:45:00"))
   //returns the monthly backup specification 
  
    Copyright © 2025 MarkLogic Corporation. MARKLOGIC is a
    registered trademark of MarkLogic Corporation.