MarkLogic Server 11.0 Product Documentation

admin.forestGetReplicas

admin.forestGetReplicas(
   config as element(configuration),
   forest-id as (Number|String)
) as Sequence

Summary

This function returns the IDs of the forest replicas for the specified forest. If it returns the empty sequence, then no replicas are assigned to the specified forest.

Required Privileges

http://marklogic.com/xdmp/privileges/admin/forest

http://marklogic.com/xdmp/privileges/admin/forest/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const forest = xdmp.forest("Documents")
  admin.forestGetReplicas(config, forest)

   //Returns the forest replicas associated with the Documents forest.