Loading TOC...
JavaScript admin.groupGetBackgroundIoLimit

MarkLogic 10 Product Documentation
admin:group-get-background-io-limit

admin:group-get-background-io-limit(
   $config as element(configuration),
   $group-id as xs:unsignedLong
) as xs:unsignedInt

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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return
  admin:group-get-background-io-limit($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.