MarkLogic 10 Product Documentation
admin.forestCreate

admin.forestCreate(
   config as element(configuration),
   forest-name as String,
   host-id as (Number|String),
   data-directory as String?,
   [large-data-directory as String?],
   [fast-data-directory as 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

  
  const admin = require('/MarkLogic/admin.xqy');
  admin.forestCreate(admin.getConfiguration(), "newForest", xdmp.host(), null)
   => 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.

MarkLogic 10 Product Documentationadmin.forestCreate

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.forestCreate