MarkLogic 9 Product Documentation
admin.forestSetForeignMaster

admin.forestSetForeignMaster(
   config as element(configuration),
   forest-id as (Number|String),
   foreign-master as element(as.foreignMaster)
) as element(configuration)

Summary

This function writes the specified foreign master forest configuration into the database replication configuration. Any forest-level configuration will override the database level-configuration. This function must be executed on the replica cluster.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
forest-id	The ID of the replica forest associated with the master forest to be set.
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.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/database

http://marklogic.com/xdmp/privileges/admin/database/{id}

http://marklogic.com/xdmp/privileges/admin/database/replication

http://marklogic.com/xdmp/privileges/admin/database/replication/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var cfg = admin.getConfiguration()
  var fcl = admin.clusterGetForeignClusterId(cfg, "ClusterA")
  var fdb = admin.databaseForeignMasterGetDatabaseId(
                   admin.databaseGetForeignMaster(cfg, xdmp.database("Documents")))
  var fforest = admin.forestForeignMaster(fcl, fdb , 3017132713745743620)
  admin.forestSetForeignMaster(cfg, xdmp.forest("Documents"), fforest)

   //Sets the configuration for the specified foreign master forest.//Use
   //admin.saveConfiguration to save the changes to the configuration or
   //pass the configuration to other Admin API functions to make other changes.

MarkLogic 9 Product Documentationadmin.forestSetForeignMaster

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.forestSetForeignMaster