admin:group-get-module-cache-timeout

admin:group-get-module-cache-timeout(
   $config as element(configuration),
   $group-id as xs:unsignedLong
) as xs:unsignedInt

Summary

This function returns the number of seconds a module can be unused before being flushed from caches. Larger values can potentially cause more memory to be used for cached modules. Smaller values can potentially cause more time to be used reloading uncached modules.

The returned value is only used when the Cache Sizing method is set to manual.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group. Typically, this is the result of an admin:group-get-id call.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
  admin:group-get-module-cache-timeout($config,
        admin:group-get-id($config, "myGroup"))
  (: returns the module cache timeout value :)
  
Powered by MarkLogic Server | Terms of Use | Privacy Policy