MarkLogic 12 EA 1 Product Documentation
admin.groupSetCompressedTreeReadSize

admin.groupSetCompressedTreeReadSize(
   config as element(configuration),
   group-id as (Number|String),
   value as Number
) as element(configuration)

Summary

This function changes the compressed tree read size setting of the group with the specified ID to the specified value. This is a "cold" operation; when you use admin.saveConfiguration to save the configuration, it will automatically restart MarkLogic Server.

If the Cache Sizing method is set to automatic (by means of the admin:group-set-cache-sizing function or the Admin UI), this function sets the compressed tree read size for the group configuration, but it is not used until the Cache Sizing method is set to manual. When the Cache Sizing method is automatic, MarkLogic will set the cache size and ignore any manual settings.

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.
value The new read size value (in kilobytes).

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

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.groupSetCompressedTreeReadSize(config, groupid, 256)

   //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.  
  
Powered by MarkLogic Server | Terms of Use | Privacy Policy