MarkLogic 9 Product Documentationadmin:forest-rename
admin:forest-rename( $config as element(configuration), $forest-id as xs:unsignedLong, $new-name as xs: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
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:forest-rename(admin:get-configuration(), 15096846875773626521, "blah")
return admin:save-configuration($config)
=> 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.