Loading TOC...

admin.databaseRetireForest

admin.databaseRetireForest(
   $config as element(configuration),
   $database-id as (Number|String),
   $forest-id as (Number|String)
) 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

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var dbid = admin.databaseGetId(config, "myDatabase")
  var forestid = admin.forestGetId(config, "myForest")
  admin.databaseRetireForest(config, dbid, forestid)

   //returns the new configuration element -- use admin.saveConfiguration
   //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.