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

admin.groupGetBackgroundIoLimit

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

Summary

This function gets the value for the I/O background limit that controls the I/O resources that I/O 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.

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');
  var config = admin.getConfiguration()
  var groupid = admin.groupGetId(config, "Default")
  admin.groupGetBackgroundIoLimit(config, groupid)

   //Returns the background I/O setting for the Default group.

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