Loading TOC...
JavaScript admin.databaseSetRetainUntilBackup

MarkLogic 12 EA 2 Product Documentation
admin:database-set-retain-until-backup

admin:database-set-retain-until-backup(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $value as xs: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



xquery version "1.0-ml";

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

let $config := admin:get-configuration()
  return
  admin:database-set-retain-until-backup($config,
        xdmp:database("myDatabase"), fn:true())

  (: 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.  :)

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