Loading TOC...
XQuery admin:forest-set-availability

MarkLogic Server 11.0 Product Documentation
admin.forestSetAvailability

admin.forestSetAvailability(
   config as element(configuration),
   forest-id as (Number|String),
   value as 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

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
admin.forestSetAvailability(config,
   admin.forestGetId(config, "Documents"),
   "offline")

 //returns the new configuration element -- use admin.saveConfiguration
 //to save the changes to the configuration or pass the configuration
 //to other Admin API functions to make other changes.

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