Loading TOC...
JavaScript admin.forestGetDatabase

admin:forest-get-database

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

Summary

This function returns the ID of the database that uses the specified forest.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
forest-id The ID of the forest used by the database to be returned (for example, xdmp:forest("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";

  let $config := admin:get-configuration()
  let $forest := xdmp:forest("Documents")

  return admin:forest-get-database($config, $forest)

  (: Returns the ID of the database that uses the Documents forest. :)

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