admin.databaseAddGeospatialElementPairIndex

admin.databaseAddGeospatialElementPairIndex(
   config as element(configuration),
   database-id as (Number|String),
   geospatial-element-pair-indexes as element(db.geospatialElementPairIndex)[]
) as element(configuration)

Summary

This function adds a geospatial element pair 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-element-pair-indexes A geospatial element pair index specification, typically the result of an admin.databaseGeospatialElementPairIndex 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 geospec =  admin.databaseGeospatialElementPairIndex("/my/namespace",
          "elementname", "/my/namespace", "lat",
	  "/my/namespace", "long", "wgs84", fn.false() )
  admin.databaseAddGeospatialElementPairIndex(config,
     xdmp.database("myDatabase"), geospec)

   //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.  
  
Powered by MarkLogic Server | Terms of Use | Privacy Policy