MarkLogic 9 Product Documentationadmin:database-is-forest-retired
admin:database-is-forest-retired( $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
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
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-retired($config, $dbid, $forestid)
(: returns true if the specified forest is retired and
false if it is not retired. :)