Loading TOC...

admin.forestDeleteForeignMaster

admin.forestDeleteForeignMaster(
   $config as element(configuration),
   $forest-id as (Number|String)
) as element(configuration)

Summary

This function deletes the master forest associated with the specified replica forest from the database replication configuration. This function must be executed on the replica host.

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 deleted from the database replication configuration.

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()
  admin.forestDeleteForeignMaster(cfg, xdmp.forest("Documents"))

   //Deletes the foreign master forest from the configuration.//Use
   //admin.saveConfiguration to save the changes to the configuration
   //or pass the configuration to other Admin API functions to make other changes. 
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.