JavaScript admin.databaseAddRangeElementIndex

MarkLogic 10 Product Documentation
admin:database-add-range-element-index

admin:database-add-range-element-index(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $range-indexes as element(db:range-element-index)*
) as element(configuration)

Summary

This function adds a range element index to 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 (for example, `xdmp:database("myDatabase")` ).
range-indexes	An element range index specification, typically the result of an `admin:database-range-element-index` call.

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()
  let $dbid := xdmp:database("Documents")
  let $rangespec := admin:database-range-element-index("string", "/my/namespace",
                "elementname", "http://marklogic.com/collation/",
		fn:false() )
  return
  admin:database-add-range-element-index($config, $dbid, $rangespec)

  (: 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-add-range-element-index

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:database-add-range-element-index