Loading TOC...

admin.groupSetExpandedTreeCachePartitions

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

Summary

This function changes the expanded 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:save-configuration 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 expanded 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.

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 A new value for the number of cache partitions.

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}

Usage Notes

The server may use fewer or more partitions than the configured value to keep partition sizes between 1024 and 12288 megabytes.

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var groupid = admin.groupGetId(config, "Default")
  admin.groupSetExpandedTreeCachePartitions(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.  
  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.