MarkLogic 9 Product Documentationadmin.forestForeignReplicaGetForestId
admin.forestForeignReplicaGetForestId( foreign-replica as element(as.foreignReplica) ) as (Number|String)
Summary
This function returns the id of the replica forest from the specified replica forest configuration element. This function must be executed on the master cluster.
| Parameters | |
|---|---|
| foreign-replica |
The element returned by the admin:forest-foreign-replica or
admin:forest-get-foreign-replicas function that specifies the
configuration for the replica forest.
|
Example
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $cfg := admin:get-configuration()
let $fmforest := admin:forest-get-foreign-replicas($cfg, xdmp:forest("Documents"))
return admin:forest-foreign-replica-get-forest-id($fmforest)
(: Returns the id for the foreign replica forest configured for the
master 'Documents' forest. :)