Loading TOC...
JavaScript admin.databaseGetForeignReplicas

admin:database-get-foreign-replicas

admin:database-get-foreign-replicas(
   $config as element(configuration),
   $database-id as xs:unsignedLong
) as element(db:foreign-replica)*

Summary

This function returns the configuration elements of the replica databases associated with the master database specified by database-id. 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.

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}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $cfg := admin:get-configuration()

  return admin:database-get-foreign-replicas($cfg, xdmp:database("Documents"))

  (: Returns the configuration element for the replica databases associated with
     the master database, 'Documents'. :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.