MarkLogic Server 11.0 Product Documentationadmin.databaseDetachForest
admin.databaseDetachForest( config as element(configuration), database-id as (Number|String), forest-id as (Number|String) ) as element(configuration)
Summary
This function detaches the specified forest from 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 (for example,
xdmp.database("myDatabase")).
|
| forest-id |
The ID of the forest. For example,
xdmp:forest("myForest") specifies the ID
for a forest named "myForest".
|
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()
admin.
databaseDetachForest(config, xdmp.database("myDatabase"),
xdmp.forest("myForest") )
=> 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.