JavaScript admin.databaseSetForeignMaster

MarkLogic 9 Product Documentation
admin:database-set-foreign-master

admin:database-set-foreign-master(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $foreign-master as element(db:foreign-master)
) 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:database-foreign-master` 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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $fdb := 476761383313557950
  let $cfg := admin:get-configuration()
  let $fcl := admin:cluster-get-foreign-cluster-id($cfg, "ClusterA")
  let $fmaster := admin:database-foreign-master($fcl, $fdb, fn:true())

  return admin:database-set-foreign-master(
                $cfg,
                xdmp:database("Documents"),
                $fmaster)

  (: Returns a configuration element that includes the foreign master configuration
     for the 'Documents' database. 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 9 Product Documentationadmin:database-set-foreign-master

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin:database-set-foreign-master