Loading TOC...
XQuery xdmp:database-is-forest-retired

xdmp.databaseIsForestRetired

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

Summary

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

Parameters
databaseId The ID of the database.
forestId The ID of the forest.

Example

  var dbId = xdmp.database("myDatabase");
  var forestId = xdmp.forest("myForest");
  xdmp.databaseIsForestRetired(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.