xdmp.databaseDescribeIndexes

xdmp.databaseDescribeIndexes(
   [database-id as (Number|String)]
) as Array

Summary

Return the list of range index specifications for the given database ID. The range index types include Range element, Range element attribute, Range field, Range path, Geospatial path, Geospatial element, Geospatial element child, Geospatial element pair, Geospatial element attribute pair, URI lexicon (system default), Collection lexicon (system default).

Parameters
database-id	The database ID.

Required Privileges

http://marklogic.com/xdmp/privileges/xdmp-database-describe-indexes

Example


xdmp.databaseDescribeIndexes(xdmp.database("Documents"));
=>
{
 "rangeElementIndexes": [
  {
    "indexId": "11741921511703150229",
    "scalarType": "dateTime",
    "namespaceURI": "http://marklogic.com/xdmp/dls",
    "localname": "created",
    "collation": "",
    "rangeValuePositions": false,
    "invalidValues": "reject"
  },
  {
    "indexId": "14501393544273516703",
    "scalarType": "unsignedLong",
    "namespaceURI": "http://marklogic.com/xdmp/dls",
    "localname": "version-id",
    "collation": "",
    "rangeValuePositions": false,
    "invalidValues": "reject"
  }
 ],
 "rangeElementAttributeIndexes": [
 ],
 "rangePathIndexes": [
 ],
 ...
}