MarkLogic 10 Product Documentationadmin:forest-get-backups
admin:forest-get-backups( $config as element(configuration), $forest-id as xs:unsignedLong ) as element(as:forest-backup)*
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
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:forest-get-backups($config, xdmp:forest("myforest") )
(: returns the scheduled backups for the forest :)