MarkLogic 10 Product Documentationadmin:forest-set-availability
admin:forest-set-availability( $config as element(configuration), $forest-id as xs:unsignedLong, $value as xs:string ) as element(configuration)
Summary
This function sets the availability state for a 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. |
| value |
The state of the forest, either online or
offline.
|
Required Privileges
This operation requires at least one of the following privileges:http://marklogic.com/xdmp/privileges/admin/database
http://marklogic.com/xdmp/privileges/admin/database/{id}
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";
let $config := admin:get-configuration()
return
admin:forest-set-availability($config,
admin:forest-get-id($config, "Documents"),
"offline")
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)