xdmp.databaseIncrementalBackup

xdmp.databaseincrementalbackupxdmpdatabaseincrementalbackup

/apidoc/8.0/xdmp:database-incremental-backup.xml

Starts an asynchronous incremental backup of the specified list of forests to the backup data directory. Optionally starts journal archiving of the specified list of forests to the specified journal archive directory. Returns a job ID that uniquely identifies the backup task.

A sequence of forest IDs.

forestIDs

String[]

A backup data directory pathname. The directory must exist and be writable by the operating system user under which MarkLogic Server is running. The directory cannot be the MarkLogic Server install directory or the MarkLogic Server data directory.

pathname

String

An incremental backup directory.

incremental-dir

String?

Whether or not to enable journal archiving. Defaults to false.

journal-archiving

Boolean?

Path to where archived journals are stored. Defaults to the backup data directory.

journal-archive-path

String?

Maximum difference in seconds that the archived journal can lag behind its forest's active journal. Defaults to 15.

lag-limit

String?

String

http://marklogic.com/xdmp/privileges/xdmp-database-incremental-backup

You cannot restore to a read-only forest.

Reindexing will stop while a backup or restore is in progress.

The backup directory must exist on each host that has a forest specified in the database backup call (that is, the d-nodes in which the forests being backed up are hosted).

If enabling journal archiving, all forests must belong to the same database.

xdmp.databaseIncrementalBackup(
    xdmp.databaseForests(xdmp.database("My-Database")),
    "/backups/Data");
=> 33030877979801813489