XQuery admin:forest-foreign-master-get-forest-id

MarkLogic 9 Product Documentation
admin.forestForeignMasterGetForestId

admin.forestForeignMasterGetForestId(
   foreign-master as element(as.foreignMaster)
) as (Number|String)

Summary

This function returns the id for the forest from the foreign master forest configuration element.

Parameters
foreign-master	The element returned by the `admin:forest-foreign-master` or `admin:forest-get-foreign-master` function that specifies the configuration for the master forest. More than one forest master configuration elements may be specified in a one-to-many replication scheme.

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-master($cfg, xdmp:forest("Documents"))

  return admin:forest-foreign-master-get-forest-id($fmforest)

  (: Returns the id for the foreign master forest. :)

MarkLogic 9 Product Documentationadmin.forestForeignMasterGetForestId

Summary

Example

MarkLogic 9 Product Documentation
admin.forestForeignMasterGetForestId