Loading TOC...

admin.databaseDeleteBackup

admin.databaseDeleteBackup(
   config as element(configuration),
   database-id as (Number|String),
   backups as element(db.databaseBackup)[]
) 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.databaseGetBackups 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');
  const config  = admin.getConfiguration()
  const dbid  = xdmp.database("Documents")
  const backups = admin.databaseGetBackups(config, dbid).toObject().slice(0,2)
  admin.databaseDeleteBackup(config, dbid, 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.  
  

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