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

admin.forestForeignMasterGetDatabaseId

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

Summary

This function returns the id for the database 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


  let admin = require("/MarkLogic/admin.xqy")
  let cfg = admin.getConfiguration()
  let fmforest = admin.forestGetForeignMaster(cfg, xdmp.forest("Documents"))
  admin.forestForeignMasterGetDatabaseId(fn.head(fmforest))