MarkLogic 10 Product Documentationxdmp: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 specified forest is retired and false the specified 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 := admin:database-get-id($config, "myDatabase")
let $forestid := admin:forest-get-id($config, "myForest")
return
xdmp:database-is-forest-retired($dbid, $forestid)
(: returns true if the specified forest is retired and
false if it is not retired. :)