Loading TOC...
XQuery admin:forest-get-enabled

MarkLogic 9 Product Documentation
admin.forestGetEnabled

admin.forestGetEnabled(
   config as element(configuration),
   forest-id as (Number|String)
) as Boolean

Summary

This function returns the enabled state of the specified forest.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
forest-id The ID of the forest. For example, xdmp:forest("myForest") specifies the ID for a forest named "myForest".

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

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  admin.forestGetEnabled(config, admin.forestGetId(config, "test"))

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