
MarkLogic 12 Product Documentation
admin.forestWeeklyBackupadmin.forestWeeklyBackup(
backup-dir as String,
backup-period as Number,
days as String[],
start-time as (Number|String)
) as element(as.forestBackup)
Summary
This function constructs a weekly scheduled backup.
| Parameters |
| backup-dir |
The directory where the backup will be saved to.
|
| backup-period |
The how many weeks between each backup.
|
| days |
The day(s) of the week. Must be a sequence of zero
or more of monday, tuesday,
wednesday, thursday,
friday, saturday,
sunday.
|
| start-time |
A time for the scheduled backup to start.
|
Example
const admin = require('/MarkLogic/admin.xqy');
admin.forestWeeklyBackup("/backupDir", 2, "monday", xs.time("09:45:00"))
//returns the weekly backup specification
Copyright © 2025 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.