JavaScript admin.databaseSetRangeIndexOptimize

MarkLogic 10 Product Documentation
admin:database-set-range-index-optimize

admin:database-set-range-index-optimize(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $value as xs:string
) as element(configuration)

Summary

This function sets the range index optimize setting for the specified database in the configuration. When set to facet-time, range indexes are optimized to minimize the amount of CPU time used. When set to memory-size, range indexes are optimized to minimize the amount of memory used.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
database-id	The ID of the database (for example, `xdmp:database("myDatabase")` ).
value	The new range index optimize value. Must be one of `facet-time` or `memory-size`.

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/database/index

http://marklogic.com/xdmp/privileges/admin/database/index/{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()
  return
  admin:database-set-range-index-optimize($config, xdmp:database("myDatabase"),
        "memory-size")

  (: returns the new configuration element -- 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 10 Product Documentationadmin:database-set-range-index-optimize

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:database-set-range-index-optimize