XQuery admin:database-add-range-element-index

MarkLogic Server 11.0 Product Documentation
admin.databaseAddRangeElementIndex

admin.databaseAddRangeElementIndex(
   config as element(configuration),
   database-id as (Number|String),
   range-indexes as element(db.rangeElementIndex)[]
) 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.databaseRangeElementIndex` 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

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const dbid = xdmp.database("Documents")
  const rangespec = admin.databaseRangeElementIndex("string", "/my/namespace",

                "elementname", "http://marklogic.com/collation/",
		fn.false() )
  admin.databaseAddRangeElementIndex(config, dbid, rangespec)
   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.databaseAddRangeElementIndex

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.databaseAddRangeElementIndex