MarkLogic 9 Product Documentation
admin.forestGetDatabase

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

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

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var forest = xdmp.forest("Documents")
  admin.forestGetDatabase(config, forest)

   //Returns the ID of the database that uses the Documents forest.

MarkLogic 9 Product Documentationadmin.forestGetDatabase

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.forestGetDatabase