Loading TOC...

admin:forest-create

admin:forest-create(
   $config as element(configuration),
   $forest-name as xs:string,
   $host-id as xs:unsignedLong,
   $data-directory as xs:string?,
   [$large-data-directory as xs:string?],
   [$fast-data-directory as xs:string?]
) as element(configuration)

Summary

This function creates a new forest configuration.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$forest-name The name of the forest. The must be unique for all forests in the cluster.
$host-id The ID of the host (for example, xdmp:host() for the current host.
$data-directory The optional data directory of the forest. If no directory is specified, then it will be a private forest.
$large-data-directory The optional directory where large objects are stored. If no directory is specified, then large objects will be stored in DATA_DIR/Forests/FOREST_NAME/Large.
$fast-data-directory The optional directory for the fast data directory for this forest. The fast data directory is typically located on a fast storage device, such as an SSD.

Required Privileges

http://marklogic.com/xdmp/privileges/admin/forest

Example

  xquery version "1.0-ml";

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

  admin:forest-create(admin:get-configuration(), "newForest", xdmp:host(), ())

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

  • There are several useful example scripts of standing up MarkLogic resources (like forests) here http://docs.marklogic.com/guide/admin-api/configure#id_89143
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy