MarkLogic 10 Product Documentationadmin.databaseGetRetiredForests
admin.databaseGetRetiredForests( config as element(configuration), database-id as (Number|String) ) as Sequence
Summary
This function returns the list of all retired forests for the specified database from the configuration.
| Parameters | |
|---|---|
| config | A configuration specification, typically as returned from one of the Admin module functions. |
| database-id | The ID of the database. |
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}
Example
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const dbid = admin.databaseGetId(config, "myDatabase")
admin.databaseGetRetiredForests(config, dbid)
//returns the IDs of all retired forests for the database