MarkLogic 12 EA 1 Product Documentation
admin:forest-delete-foreign-master

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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $cfg := admin:get-configuration()

  return admin:forest-delete-foreign-master($cfg, xdmp:forest("Documents"))

  (: Deletes the foreign master forest from the configuration.  Use
     admin:save-configuration to save the changes to the configuration
     or pass the configuration to other Admin API functions to make other changes. :):)
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy