MarkLogic Server 11.0 Product Documentation
admin.forestDeleteBackup

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

Summary

This function deletes scheduled backup specifications for a forest from 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(s) to delete. Typically, the result of an `admin:forest-get-backups` 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("Documents")
  const backups = admin.forestGetBackups(config, forest).toObject().slice(0,2)
  admin.forestDeleteBackup(config, forest, backups)

   //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 Server 11.0 Product Documentationadmin.forestDeleteBackup

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.forestDeleteBackup