XQuery admin:database-monthly-incremental-backup

MarkLogic 10 Product Documentation
admin.databaseMonthlyIncrementalBackup

admin.databaseMonthlyIncrementalBackup(
   backup-dir as String,
   backup-period as Number,
   backup-month-day as (Number|String),
   start-time as (Number|String),
   backup-security-db as Boolean,
   backup-schemas-db as Boolean,
   backup-triggers-db as Boolean,
   [include-replicas as Boolean],
   [incremental-dir as String?],
   [purge-journal-archive 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 scheduled monthly incremental backup specification.

Parameters
backup-dir	The directory where the full backup is located.
backup-period	The number of months to elapse between each incremental backup.
backup-month-day	The day of the month the incremental backup will happen (between 1 and 31).
start-time	A time for the scheduled incremental backup to start.
backup-security-db	Whether to backup the security database alongside the current incremental backup.
backup-schemas-db	Whether to backup the schemas database alongside the current incremental backup.
backup-triggers-db	Whether to backup the triggers database alongside the current incremental backup.
include-replicas	If set to `false`, do not include the replicas in the incremental backup. The default is `true`, which means to include all replicas in the incremental backup.
incremental-dir	The directory in which to save the incremental backup.
purge-journal-archive	Whether or not to purge journal archive after incremental backup is performed. Defaults to `false`
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.databaseMonthlyIncrementalBackup("/backupDir", 2, 1,
        xs.time("09:45:00"),"true","true","true")

   //returns the monthly backup specification

MarkLogic 10 Product Documentationadmin.databaseMonthlyIncrementalBackup

Summary

Example

MarkLogic 10 Product Documentation
admin.databaseMonthlyIncrementalBackup