MarkLogic 10 Product Documentation
admin:forest-add-backup

admin:forest-add-backup(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $backups as element(as:forest-backup)*
) as element(configuration)

Summary

This function adds scheduled backup specifications for a forest to a 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")` ).
backups	The scheduled backup specification(s), typically the result of an `admin:forest-one-time-backup` or an `admin:forest-monthly-backup` or an `admin:forest-weekly-backup` call

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}

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

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

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

http://marklogic.com/xdmp/privileges/admin/forest/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()
  let $forest := xdmp:forest("myforest")
  let $backup := admin:forest-one-time-backup("/backup-dir",
        xs:dateTime("2008-02-14T09:45:00"))
  return
  admin:forest-add-backup($config, $forest, $backup)

  (: 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.  :)

MarkLogic 10 Product Documentationadmin:forest-add-backup

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:forest-add-backup