MarkLogic 10 Product Documentation
admin.forestGetHost

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

Summary

This function returns the ID of the host in which the specified forest resides.

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');
  admin.forestGetHost(admin.getConfiguration(), xdmp.forest("myForest"))
  => the ID of the host that services the forest named "myForest"

MarkLogic 10 Product Documentationadmin.forestGetHost

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.forestGetHost