Loading TOC...
JavaScript admin.forestGetForeignMaster

admin:forest-get-foreign-master

admin:forest-get-foreign-master(
   $config as element(configuration),
   $forest-id as xs:unsignedLong
) as element(as:foreign-master)?

Summary

This function returns the replication configuration for the master forest associated with the specified replica forest. This function must be executed on the replica host.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
forest-id The ID of the replica 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-master($cfg, xdmp:forest("Documents"))

 (: Returns the replication configuration for the master forest. :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.