Loading TOC...

admin.databaseIsForestRetired

admin.databaseIsForestRetired(
   $config as element(configuration),
   $database-id as (Number|String),
   $forest-id as (Number|String)
) as Boolean

Summary

This function returns fn:true() if the specified forest is retired and fn:false() the specified forest is not retired.

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.

Example

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

   //returns true if the specificed forest is retired and
   //false if it is not retired. 
    

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