MarkLogic Server 11.0 Product Documentation
admin:database-minutely-incremental-backupadmin:database-minutely-incremental-backup(
$backup-dir as xs:string,
$backup-period as xs:positiveInteger,
$backup-security-db as xs:boolean,
$backup-schemas-db as xs:boolean,
$backup-triggers-db as xs:boolean,
[$include-replicas as xs:boolean],
[$incremental-dir as xs:string?],
[$purge-journal-archive as xs:boolean?],
[$journal-archiving as xs:boolean?],
[$journal-archive-path as xs:string?],
[$lag-limit as xs:unsignedLong?]
) as element(db:database-backup)
Summary
This function constructs a scheduled incremental database backup specification based on a number of minutes.
Parameters |
backup-dir |
The directory where the full backup is located. |
backup-period |
The number of minutes to elapse between each incremental backup. |
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
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-minutely-incremental-backup("/backup-dir",10,true(),true(),true())
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.