MarkLogic 9 Product Documentationadmin:forest-get-fast-data-max-size
admin:forest-get-fast-data-max-size( $config as element(configuration), $forest-id as xs:unsignedLong ) as xs:unsignedInt
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
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $cfg := admin:get-configuration()
let $fid := admin:forest-get-id($cfg, "myForest")
return admin:forest-get-fast-data-max-size($cfg, $fid)
(: Returns the configured limit, or zero,
for the myForest forest. :)