Loading TOC...

admin:database-attach-sub-database

admin:database-attach-sub-database(
   config as element(configuration),
   database-id as xs:unsignedLong,
   subdatabase-id as xs:unsignedLong,
   [foreign-cluster-id as xs:unsignedLong]
) 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



xquery version "1.0-ml";

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

let $config := admin:get-configuration()
let $databaseid := xdmp:database("Documents")
let $subdatabaseid := xdmp:database("MySubDatabase")
return
admin:database-attach-sub-database($config, $databaseid, $subdatabaseid)

  (: returns the new configuration element -- use admin:save-configuration
     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.