Loading TOC...
JavaScript admin.forestSetEnabled

MarkLogic 10 Product Documentation
admin:forest-set-enabled

admin:forest-set-enabled(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $value as xs:boolean
) as element(configuration)

Summary

This function sets the enabled state for a forest configuration.

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".
value The new state of the forest, for example fn:true() for enabled, fn:false() for disabled.

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

  => sets the forest named "Documents" to the disabled state.
     Use admin:save-configuration 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.