MarkLogic 10 Product Documentationadmin.forestGetFastDataMaxSize
admin.forestGetFastDataMaxSize( config as element(configuration), forest-id as (Number|String) ) as Number
Summary
This function returns maximum allowable size (in megabytes) of the data to be kept by the specified forest in its fast-data-directory, or 0 for no limit.
| Parameters | |
|---|---|
| config | A configuration specification, typically as returned from one of the Admin module functions. |
| forest-id | The ID of the forest. |
Required Privileges
This operation requires at least one of the following privileges:http://marklogic.com/xdmp/privileges/admin/forest
http://marklogic.com/xdmp/privileges/admin/forest/{id}
Example
const admin = require('/MarkLogic/admin.xqy');
const cfg = admin.getConfiguration()
const fid = admin.forestGetId(cfg, "myForest")
admin.forestGetFastDataMaxSize(cfg, fid)
//Returns the configured limit, or zero,
//for the myForest forest.