MarkLogic Server 11.0 Product Documentation
admin.databaseMinutelyBackupadmin.databaseMinutelyBackup(
backup-dir as String,
backup-period as Number,
max-backups as (Number|String),
backup-security-db as Boolean,
backup-schemas-db as Boolean,
backup-triggers-db as Boolean,
[include-replicas 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 database backup specification on a number-of-minutes basis.
Parameters |
backup-dir |
The directory to save the backup. |
backup-period |
The number of minutes to elapse between each backup. |
max-backups |
The maximum number of backups to keep. When you reach the specified
maximum number of backups, the next backup will delete the oldest
backup.
Specify 0 to keep an unlimited number of backups.
This setting does not apply for incremental backups.
|
backup-security-db |
Whether to backup the security database alongside the current
backup.
|
backup-schemas-db |
Whether to backup the schemas database alongside the current
backup.
|
backup-triggers-db |
Whether to backup the triggers database alongside the current
backup.
|
include-replicas |
If set to false , do not include the replicas in
the backup. The default is true , which means to
include all replicas in the backup.
|
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');
const config = admin.getConfiguration()
admin.databaseMinutelyBackup("/backupDir", 45,
10, true(), true(), true())
//Returns the minutely database backup specification.
Example
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
admin.databaseMinutelyBackup("/backupDir", 45,
10, "true", "true", "true","false","true",null,500)
//Returns the minutely database backup specification.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.