admin:database-get-range-index-optimize

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

Summary

This function returns the range index optimize setting for the specified database from 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")).

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


  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-get-range-index-optimize($config, xdmp:database("myDatabase"))
  (: returns the range index optimize setting :)
  
Powered by MarkLogic Server | Terms of Use | Privacy Policy