MarkLogic Server 11.0 Product Documentation
admin.databaseOneTimeIncrementalBackupadmin.databaseOneTimeIncrementalBackup(
backup-dir as String,
start as Date,
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 one-time incremental backup specification.
Parameters |
backup-dir |
The directory where the full backup is located. |
start |
The starting dateTime of the scheduled 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
const admin = require('/MarkLogic/admin.xqy');
admin.databaseOneTimeIncrementalBackup("/backupDir",
xs.dateTime("2014-07-14T09:45:00"),"true","true","true")
//returns the oneTime incremental backup
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.