MarkLogic 9 Product Documentation
admin.databaseAddBackup

admin.databaseAddBackup(
   config as element(configuration),
   database-id as (Number|String),
   backups as element(db.databaseBackup)[]
) as element(configuration)

Summary

This function adds scheduled backup specifications for a database to a configuration.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
database-id	The ID of the database (for example, `xdmp:database("mydatabase")`).
backups	The scheduled backup specification(s), typically the result of an `admin:database-one-time-backup` or an `admin:database-monthly-backup` or an `admin:database-weekly-backup` call

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/database

http://marklogic.com/xdmp/privileges/admin/database/backup

http://marklogic.com/xdmp/privileges/admin/database/backup/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var database = xdmp.database("mydatabase")
  var backup = admin.databaseOneTimeBackup("/backupDir",
        xs.dateTime("2008-02-14T09:45:00"),10,"true","true","true")
  admin.databaseAddBackup(config, database, backup)

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.

MarkLogic 9 Product Documentationadmin.databaseAddBackup

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.databaseAddBackup