Loading TOC...

admin.databaseAttachSubDatabase

admin.databaseAttachSubDatabase(
   $config as element(configuration),
   $database-id as (Number|String),
   $subdatabase-id as (Number|String),
   [$foreign-cluster-id as (Number|String)]
) as element(configuration)

Summary

This function adds a sub-database to a super-database.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$database-id The ID of the super-database.
$subdatabase-id The ID of the sub-database.
$foreign-cluster-id The ID of the foreign cluster.

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');
var config = admin.getConfiguration()
var databaseid = xdmp.database("Documents")
var subdatabaseid = xdmp.database("MySubDatabase")
admin.databaseAttachSubDatabase(config, databaseid, subdatabaseid)

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.  
    

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