admin.databaseSetForeignMaster

admin.databaseSetForeignMaster(
   config as element(configuration),
   database-id as (Number|String),
   foreign-master as element(db.foreignMaster)
) as element(configuration)

Summary

This function configures the specified replica database to receive replicated data from the specified foreign master. This function must be executed on the replica cluster.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database.
foreign-master The foreign master configuration returned by the admin.databaseForeignMaster function.

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 = 476761383313557950
  const cfg = admin.getConfiguration()
  const fcl = admin.clusterGetForeignClusterId(cfg, "ClusterA")
  const fmaster = admin.databaseForeignMaster(fcl, fdb, fn.true())
  admin.databaseSetForeignMaster(
                cfg,
                xdmp.database("Documents"),
                fmaster)

   //Returns a configuration element that includes the foreign master 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. 
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy