JavaScript admin.databaseForeignMasterGetConnectForestsByName

admin:database-foreign-master-get-connect-forests-by-name

admin:database-foreign-master-get-connect-forests-by-name(
   $foreign-master as element(db:foreign-master)
) as xs:boolean

Summary

This function returns the connect-forests-by-name setting from the master database configuration. This function must be executed on the replica cluster.

Parameters
foreign-master	The configuration element for the foreign master.

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 $fmaster := admin:database-get-foreign-master($cfg, xdmp:database("Documents"))

  return admin:database-foreign-master-get-connect-forests-by-name($fmaster)

  (: Returns the connect-forests-by-name setting from the foreign master database
     configuration element. :)