MarkLogic 12 Product Documentation

admin:forest-delete-backup

admin:forest-delete-backup(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $backups as element(as:forest-backup)*
) as element(configuration)

Summary

This function deletes scheduled backup specifications for a forest from a configuration.

Required 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

  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config  := admin:get-configuration()
  let $forest  := xdmp:forest("Documents")
  let $backups := admin:forest-get-backups($config, $forest)[1 to 3]
  return
  admin:forest-delete-backup($config, $forest, $backups)

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)