MarkLogic Server 11.0 Product Documentationadmin:forest-get-availability
admin:forest-get-availability( $config as element(configuration), $forest-id as xs:unsignedLong ) as xs:string
Summary
This function gets the availability state of the forest,
for use in Tiered Storage. A forest can have an availability
state of online or offline.
| Parameters | |
|---|---|
| config | A configuration specification, typically as returned from one of the Admin module functions. |
| forest-id | The ID of the forest. |
Required Privileges
This operation requires at least one of the following privileges:http://marklogic.com/xdmp/privileges/admin/forest
http://marklogic.com/xdmp/privileges/admin/forest/{id}
Example
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:forest-get-availability(admin:get-configuration(),
xdmp:forest("Documents"))
=> online