JavaScript admin.forestAddForeignReplicas

MarkLogic Server 11.0 Product Documentation
admin:forest-add-foreign-replicas

admin:forest-add-foreign-replicas(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $foreign-replicas as element(as:foreign-replica)*
) as element(configuration)

Summary

This function adds the replica forest that is associated with the specified master forest to the database replication configuration. This function must be executed on the master host.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
forest-id	The ID of the forest on the master host to be replicated.
foreign-replicas	The element returned by the `admin:forest-foreign-replica` function that specifies the configuration for the replica forest. More than one forest replica 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-replica-get-database-id(
                      admin:database-get-foreign-replicas($cfg, xdmp:database("Documents")))
  let $mforest := xdmp:forest("Documents2")
  let $fforest := admin:forest-foreign-replica($fcl, $fdb , 2863600501631949400)

  return admin:forest-add-foreign-replicas($cfg, $mforest, $fforest)

  (: Adds the foreign forest, 'Document2', to the forests used by the replica database,
    'Documents'.  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 Server 11.0 Product Documentationadmin:forest-add-foreign-replicas

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:forest-add-foreign-replicas