MarkLogic 12 Product Documentation
admin:database-delete-backup

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

Summary

This function deletes scheduled backup specifications for a database from 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(s) to delete. Typically, the result of an `admin:database-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/backup

http://marklogic.com/xdmp/privileges/admin/database/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 $dbid  := xdmp:database("Documents")
  let $backups := admin:database-get-backups($config, $dbid)[1 to 3]
  return
  admin:database-delete-backup($config, $dbid, $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.  :)

MarkLogic 12 Product Documentationadmin:database-delete-backup

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin:database-delete-backup