JavaScript admin.forestSetRangePolicyRange

MarkLogic 12 EA 1 Product Documentation
admin:forest-set-range-policy-range

admin:forest-set-range-policy-range(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $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



xquery version "1.0-ml";

import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

let $config := admin:get-configuration()
let $forestid := admin:forest-get-id($config, "myForest")
let $config := admin:forest-set-range-policy-range($config, $forestid, 1, 11)
return admin:save-configuration($config)

(: Note that if both $lower-bound and $upper-bound are the empty sequence, the forest
   essentially no longer has a range configured. Use admin:save-configuration to save
   the changes to the configuration or pass the configuration to other Admin API
   functions to make other changes. :)

MarkLogic 12 EA 1 Product Documentationadmin:forest-set-range-policy-range

Summary

Required Privileges

Example

MarkLogic 12 EA 1 Product Documentation
admin:forest-set-range-policy-range