Loading TOC...


   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $forest-id as xs:unsignedLong
) as element(configuration)


This function attaches the specified forest to the specified database.

$config A configuration specification, typically as returned from one of the Admin module functions.
$database-id The ID of the database (for example, xdmp:database("myDatabase")).
$forest-id The ID of the forest. For example, xdmp:forest("myForest") specifies the ID for a forest named "myForest".

Usage Notes

Any forest whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the forest, do so in a separate transaction before using them in this function.


  xquery version "1.0-ml";

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

  let $config := admin:get-configuration()
  admin:database-attach-forest($config, xdmp:database("myDatabase"),
      xdmp:forest("myForest") )

   => 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.


    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy