Loading TOC...

admin.databaseGetRetainUntilBackup

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

Summary

This function returns the "retain until backup" setting from 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")).

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/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
var config = admin.getConfiguration()
admin.databaseGetRetainUntilBackup(config, xdmp.database("myDatabase"))

    

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