Loading TOC...

admin:database-employ-forest

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

Summary

This function "employs" the specified forest in the configuration. This function can be used to "unretire" a forest that was previously retired by the admin:database-retire-forest function.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$database-id The ID of the database.
$forest-id The ID of the forest.

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 $dbid := admin:database-get-id($config, "myDatabase")
  let $forestid := admin:forest-get-id($config, "myForest")
  return
  admin:database-employ-forest($config, $dbid, $forestid)

  (: 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.  :)
     

Comments

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