MarkLogic 10 Product Documentation
admin:forest-get-name

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

Summary

This function returns the name of the specified forest, given the forest ID.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
forest-id	The ID of the forest. If the ID does not correspond to a valid forest ID, then an exception is thrown.

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-name(admin:get-configuration(), 18220031759147104956)

MarkLogic 10 Product Documentationadmin:forest-get-name

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:forest-get-name