MarkLogic 12 EA 1 Product Documentation

xdmp.databaseIsForestRetired

xdmp.databaseIsForestRetired(
   databaseId as String,
   forestId as String
) as Boolean

Summary

This function returns true if the specified forest is retired and false the specified forest is not retired.

Example

  var dbId = xdmp.database("myDatabase");
  var forestId = xdmp.forest("myForest");
  xdmp.databaseIsForestRetired(dbId, forestId)
  // returns true if the specified forest is retired and
     false if it is not retired.