Loading TOC...
JavaScript xdmp.databaseIsForestRetired

xdmp:database-is-forest-retired

xdmp:database-is-forest-retired(
   $database-id as xs:unsignedLong,
   $forest-id as xs:unsignedLong
) as xs:boolean

Summary

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

Parameters
$database-id The ID of the database.
$forest-id The ID of the forest.

Example

  xquery version "1.0-ml";
  let $dbid := xdmp:database("myDatabase")
  let $forestid := xdmp:forest("myForest")
  return
  xdmp:database-is-forest-retired($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.