Loading TOC...
XQuery admin:database-reorder-forests

admin.databaseReorderForests

admin.databaseReorderForests(
   config as element(configuration),
   database-id as (Number|String),
   forest-ids as (Number|String)[]
) 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

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const dbid = admin.databaseGetId(config, "myDatabase")
  const forest1 = admin.forestGetId(config, "myForest1")
  const forest2 = admin.forestGetId(config, "myForest2")
  const forest3 = admin.forestGetId(config, "myForest3")
  admin.databaseReorderForests(config, dbid, (forest3,forest2,forest1))

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

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.