MarkLogic 9 Product Documentation
admin:forest-set-host

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

Summary

This function sets a forest configuration to a new host.

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 host ID of the new host.

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-host($config, admin:forest-get-id($config, "Documents"),
              xdmp:host("myNewHost"))

   => 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.

MarkLogic 9 Product Documentationadmin:forest-set-host

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin:forest-set-host