MarkLogic 10 Product Documentation
admin:database-reorder-forests

admin:database-reorder-forests(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $forest-ids as xs:unsignedLong*
) as element(configuration)

Summary

This function reorders the forests in the specified database.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
database-id	The ID of the database.
forest-ids	The list of forest IDs in the desired order.

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/forests

http://marklogic.com/xdmp/privileges/admin/database/forests/{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 $dbid := admin:database-get-id($config, "myDatabase")
  let $forest-1 := admin:forest-get-id($config, "myForest1")
  let $forest-2 := admin:forest-get-id($config, "myForest2")
  let $forest-3 := admin:forest-get-id($config, "myForest3")
  return
  admin:database-reorder-forests($config, $dbid, ($forest-3,$forest-2,$forest-1))

  (: 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.  :)

MarkLogic 10 Product Documentationadmin:database-reorder-forests

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:database-reorder-forests