Loading TOC...
XQuery admin:group-set-background-io-limit

MarkLogic Server 11.0 Product Documentation
admin.groupSetBackgroundIoLimit

admin.groupSetBackgroundIoLimit(
   config as element(configuration),
   group-id as (Number|String),
   max-megabytes-per-second as Number
) as element(configuration)

Summary

This function sets a limit on the amount of I/O that background tasks (for example, merges) will consume. If the limit is reached, then merges are throttled back to limit their maximum I/O. This can help in situations when the I/O system on the computer is maxed out. In normal operations, you should not need to set this parameter.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
max-megabytes-per-second A number representing the maximum amount of I/O, in megabytes-per-second, to allow for each host in the group.

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.groupSetBackgroundIoLimit(config, groupid, 100)

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