Loading TOC...
JavaScript admin.databaseRetireForest

MarkLogic 9 Product Documentation
admin:database-retire-forest

admin:database-retire-forest(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $forest-id as xs:unsignedLong
) as element(configuration)

Summary

This function "retires" the specified forest in the configuration. To "unretire," or "redeploy" a retired forest, use the admin:database-employ-forest function.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database.
forest-id The ID of the forest.

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/forests

http://marklogic.com/xdmp/privileges/admin/database/forests/{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 $dbid := admin:database-get-id($config, "myDatabase")
  let $forestid := admin:forest-get-id($config, "myForest")
  return
  admin:database-retire-forest($config, $dbid, $forestid)

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