MarkLogic 10 Product Documentationadmin.forestGetForeignReplicas
admin.forestGetForeignReplicas( config as element(configuration), forest-id as (Number|String) ) as Sequence
Summary
This function returns the foreign replicas configuration element. This function must be executed on the master cluster.
| Parameters | |
|---|---|
| config | A configuration specification, typically as returned from one of the Admin module functions. |
| forest-id | The ID of the master forest. |
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');
const cfg = admin.getConfiguration()
admin.forestGetForeignReplicas(cfg, xdmp.forest("Documents"))
//Returns the configuration element for the foreign replicas.