Loading TOC...

admin:database-is-forest-employed

admin:database-is-forest-employed(
   config as element(configuration),
   database-id as xs:unsignedLong,
   forest-id as xs:unsignedLong
) as xs:boolean

Summary

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

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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
         at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $dbid := admin:database-get-id($config, "myDatabase")
  let $forestid := admin:forest-get-id($config, "myForest")
  return
  admin:database-is-forest-employed($config, $dbid, $forestid)
  (: returns true if the specified forest is employed and
     false if it is not employed. :)
     

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