XQuery admin:database-add-geospatial-path-index

MarkLogic 9 Product Documentation
admin.databaseAddGeospatialPathIndex

admin.databaseAddGeospatialPathIndex(
   config as element(configuration),
   database-id as (Number|String),
   geospatial-path-indexes as element(db.geospatialPathIndex)[]
) as element(configuration)

Summary

This function adds a range path 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")).
geospatial-path-indexes	A geospatial path index specification, typically the result of an admin:database-geospatial-path-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

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var dbid = xdmp.database("Documents")
  var indexspec =   admin.databaseGeospatialPathIndex(
    "/aaa.a/aaa.b",
    "wgs84",
    fn.false(),
    "longLatPoint",
    "reject" )
    admin.databaseAddGeospatialPathIndex(config, dbid, indexspec)

   //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 9 Product Documentationadmin.databaseAddGeospatialPathIndex

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.databaseAddGeospatialPathIndex