JavaScript admin.databaseSetForeignReplicas

MarkLogic 10 Product Documentation
admin:database-set-foreign-replicas

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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $fdb := 7746794057802787479
  let $cfg := admin:get-configuration()
  let $fcl := admin:cluster-get-foreign-cluster-id($cfg, "ClusterA")
  let $freplica := admin:database-foreign-replica($fcl, $fdb, fn:true(), 300)

  return admin:database-set-foreign-replicas($cfg, xdmp:database("Documents"), $freplica)

  (: Returns the full database configuration element that includes the replication 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 10 Product Documentationadmin:database-set-foreign-replicas

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:database-set-foreign-replicas