Loading TOC...
XQuery admin:forest-get-name

admin.forestGetName

admin.forestGetName(
   config as element(configuration),
   forest-id as (Number|String)
) as 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

  
  const admin = require('/MarkLogic/admin.xqy');
  admin.forestGetName(admin.getConfiguration(), 18220031759147104956)

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