MarkLogic 10 Product Documentation
admin:forest-set-foreign-master

admin:forest-set-foreign-master(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $foreign-master as element(as:foreign-master)
) 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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $cfg := admin:get-configuration()
  let $fcl := admin:cluster-get-foreign-cluster-id($cfg, "ClusterA")
  let $fdb := admin:database-foreign-master-get-database-id(
                   admin:database-get-foreign-master($cfg, xdmp:database("Documents")))
  let $fforest := admin:forest-foreign-master($fcl, $fdb , 3017132713745743620)

  return admin:forest-set-foreign-master($cfg, xdmp:forest("Documents"), $fforest)

  (: Sets the configuration for the specified foreign master forest.  Use
     admin:save-configuration to save the changes to the configuration or
     pass the configuration to other Admin API functions to make other changes. :):)

MarkLogic 10 Product Documentationadmin:forest-set-foreign-master

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:forest-set-foreign-master