XQuery admin:database-set-foreign-replicas

MarkLogic 10 Product Documentation
admin.databaseSetForeignReplicas

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

Summary

This function sets the foreign replica database configuration. 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.
replicas	One or more replica configuration elements. 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');
  const fdb = 7746794057802787479
  const cfg = admin.getConfiguration()
  const fcl = admin.clusterGetForeignClusterId(cfg, "ClusterA")
  const freplica = admin.databaseForeignReplica(fcl, fdb, fn.true(), 300)
  admin.databaseSetForeignReplicas(cfg, xdmp.database("Documents"), freplica)

   //Returns the full database configuration element that includes the replication configuration
   //for the 'Documents' database. Use admin.saveConfiguration to save the changes to the
   //configuration or pass the configuration to other Admin API functions to make other changes.

MarkLogic 10 Product Documentationadmin.databaseSetForeignReplicas

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.databaseSetForeignReplicas