MarkLogic 10 Product Documentationadmin:forest-get-foreign-replicas
admin:forest-get-foreign-replicas( $config as element(configuration), $forest-id as xs:unsignedLong ) as element(as:foreign-replica)*
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
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $cfg := admin:get-configuration()
return admin:forest-get-foreign-replicas($cfg, xdmp:forest("Documents"))
(: Returns the configuration element for the foreign replicas. :)