Loading TOC...

admin.databaseSetRetainUntilBackup

admin.databaseSetRetainUntilBackup(
   $config as element(configuration),
   $database-id as (Number|String),
   $value as Boolean
) as element(configuration)

Summary

This function sets "the retain until backup" setting in the configuration for the specified database.

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")).
$value Whether or not to keep the deleted fragments until a full backup or an incremental backup.

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');
var config = admin.getConfiguration()
  admin.databaseSetRetainUntilBackup(config,
        xdmp.database("myDatabase"), fn.true())

   //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.