JavaScript admin.databaseDeleteForeignReplicas

MarkLogic Server 11.0 Product Documentation
admin:database-delete-foreign-replicas

admin:database-delete-foreign-replicas(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $foreign-replicas as element(db:foreign-replica)*
) 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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $cfg := admin:get-configuration()
  let $freplica := admin:database-get-foreign-replicas($cfg, xdmp:database("Documents"))

  return admin:database-delete-foreign-replicas($cfg, xdmp:database("Documents"), $freplica)

  (: Removes the foreign replica databases for the master database, 'Documents', from
     the database replication 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. :)

MarkLogic Server 11.0 Product Documentationadmin:database-delete-foreign-replicas

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:database-delete-foreign-replicas