XQuery admin:database-delete-foreign-replicas

admin.databaseDeleteForeignReplicas

admin.databaseDeleteForeignReplicas(
   config as element(configuration),
   database-id as (Number|String),
   foreign-replicas as element(db.foreignReplica)[]
) as element(configuration)

Summary

This function deletes the foreign replica database configurations for the specified master database. This function must be executed on the master cluster.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
database-id	The ID of the database.
foreign-replicas	The configuration elements for the replica databases. These configuration elements can be returned using the `admin:database-get-foreign-replicas` function. More than one replica database 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

  
  const admin = require('/MarkLogic/admin.xqy');
  var cfg = admin.getConfiguration()
  var freplica = admin.databaseGetForeignReplicas(cfg, xdmp.database("Documents"))
  admin.databaseDeleteForeignReplicas(cfg, xdmp.database("Documents"), freplica)

   //Removes the foreign replica databases for the master database, 'Documents', from
   //the database replication configuration.//Use admin.saveConfiguration to save the
   //changes to the configuration or pass the configuration to other Admin API functions
   //to make other changes.