MarkLogic Server 11.0 Product Documentation

admin.groupSetCompressedTreeCachePartitions

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

Summary

This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. 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, enode, or dnode (by means of the admin:group-set-cache-sizing function or the Admin UI), this function sets the compressed tree cache partitions 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, enode or dnode, MarkLogic will set the cache partitions and ignore any manual settings.

Required Privileges

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

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

Usage Notes

Example

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

   //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.