Loading TOC...

admin.databaseSetRebalancerThrottle

admin.databaseSetRebalancerThrottle(
   config as element(configuration),
   database-id as (Number|String),
   value as Number
) as element(configuration)

Summary

This function sets the rebalancer throttle setting for the specified database in the configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database.
value The new setting, which must be a number between 1 and 5 (inclusive). Larger numbers mean to work harder at rebalancing.

Required Privileges

This operation requires at least one of the following privileges:

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const dbid = admin.databaseGetId(config, "myDatabase")
  admin.databaseSetRebalancerThrottle(config, dbid, 5)

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