Loading TOC...

admin.databaseDeleteRangeElementIndex

admin.databaseDeleteRangeElementIndex(
   $config as element(configuration),
   $database-id as (Number|String),
   $range-indexes as element(db.rangeElementIndex)[]
) as element(configuration)

Summary

This function deletes a range element index for 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}

Usage Notes

Note that the index specification to delete must exist in the configuration exactly as specified, even if the specification includes multiple QNames. If you have a range index configuration that specifies multiple QNames in a single entry, then if you want to delete the index for only one of the QNames, you must first delete the range index specification with multiple QNames and then add the indexes that you do not want to delete. To see the specifications as they are stored in the configuration, use admin:database-get-range-element-index.

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var dbid = xdmp.database("Documents")
  var rangespec = admin.databaseRangeElementIndex("string", "/my/namespace",

                "elementname", "http://marklogic.com/collation/",
		fn.false() )
  admin.databaseDeleteRangeElementIndex(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.  
  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.