MarkLogic Server 11.0 Product Documentation
admin:forest-get-enabled

admin:forest-get-enabled(
   $config as element(configuration),
   $forest-id as xs:unsignedLong
) as xs: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


  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-get-enabled($config, admin:forest-get-id($config, "test"))

MarkLogic Server 11.0 Product Documentationadmin:forest-get-enabled

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:forest-get-enabled