Loading TOC...

admin.databaseGetForeignReplicas

admin.databaseGetForeignReplicas(
   $config as element(configuration),
   $database-id as (Number|String)
) as Sequence

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

  
  const admin = require('/MarkLogic/admin.xqy');
  var cfg = admin.getConfiguration()
  admin.databaseGetForeignReplicas(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.