Loading TOC...
JavaScript admin.forestGetHost

MarkLogic 12 Product Documentation
admin:forest-get-host

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

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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  admin:forest-get-host(admin:get-configuration(), xdmp:forest("myForest"))

  => the ID of the host that services the forest named "myForest"

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