Loading TOC...

admin.forestSetRangePolicyRange

admin.forestSetRangePolicyRange(
   $config as element(configuration),
   $forest-id as (Number|String),
   $lower-bound as Item?,
   $upper-bound as Item?
) as element(configuration)

Summary

This function sets the boundaries of the range on a forest.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$forest-id The ID of the forest.
$lower-bound The lower boundary. If it is the empty sequence, the lower boundary is set to be negative infinity.
$upper-bound The upper boundary. If it is the empty sequence, the upper boundary is set to be positive infinity.

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}

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

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

Example

const admin = require('/MarkLogic/admin.xqy');
var config = admin.getConfiguration()
var forestid = admin.forestGetId(config, "myForest")
var config = admin.forestSetRangePolicyRange(config, forestid, 1, 11)
admin.saveConfiguration(config)

 //Note that if both lowerBound and upperBound are the empty sequence, the forest
 //essentially no longer has a range configured. 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.