Loading TOC...
XQuery admin:forest-get-backups

MarkLogic 12 Product Documentation
admin.forestGetBackups

admin.forestGetBackups(
   config as element(configuration),
   forest-id as (Number|String)
) as Sequence

Summary

This function returns the scheduled backups for the specified forest from the configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
forest-id The ID of the forest (for example, xdmp.forest("myForest") ).

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/forest

http://marklogic.com/xdmp/privileges/admin/forest/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  admin.forestGetBackups(config, xdmp.forest("myforest") )

   //returns the scheduled backups for the forest

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