Loading TOC...

admin.forestRename

admin.forestRename(
   $config as element(configuration),
   $forest-id as (Number|String),
   $new-name as String
) as element(configuration)

Summary

This function renames a forest.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$forest-id The ID of the forest.
$new-name New name to give the forest.

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

http://marklogic.com/xdmp/privileges/admin/forest/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
var config = admin.forestRename(admin.getConfiguration(), 15096846875773626521, "blah")
admin.saveConfiguration(config)
   => 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.