MarkLogic 9 Product Documentation
admin.forestAddReplica

admin.forestAddReplica(
   config as element(configuration),
   master-id as (Number|String),
   replica-id as (Number|String)
) as element(configuration)

Summary

This function adds a forest replica to a master forest. Note that adding a replica forest will take the master forest offline for a period ranging between a few seconds to a few minutes.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
master-id	The ID of the master forest to which to add the replica forest (for example, `xdmp:forest("MasterForest")`).
replica-id	The ID of the replica forest to add to the master forest (for example, `xdmp:forest("ReplicaForest")`).

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/forest

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var forest = xdmp.forest("Documents")
  var replicaForest = xdmp.forest("myReplica")
  admin.forestAddReplica(config, forest, replicaForest)

   //returns the new configuration element --
   //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.forestAddReplica

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.forestAddReplica