Loading TOC...

admin.forestAddBackup

admin.forestAddBackup(
   $config as element(configuration),
   $forest-id as (Number|String),
   $backups as element(as.forestBackup)[]
) as element(configuration)

Summary

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

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$forest-id The ID of the forest (for example, xdmp.forest("myForest") ).
$backups The scheduled backup specification(s), typically the result of an admin.forestOneTimeBackup or an admin.forestMonthlyBackup or an admin.forestWeeklyBackup 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/{id}

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

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

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const forest = xdmp.forest("myforest")
  const backup = admin.forestOneTimeBackup("/backupDir",
        xs.dateTime("2008-02-14T09:45:00"))
  admin.forestAddBackup(config, forest, 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.  
  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.