admin:database-add-geospatial-path-index

admin:database-add-geospatial-path-index(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $geospatial-path-indexes as element(db:geospatial-path-index)*
) 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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $dbid := xdmp:database("Documents")
  let $indexspec :=   admin:database-geospatial-path-index(
    "/aaa:a/aaa:b",
    "wgs84",
    fn:false(),
    "long-lat-point",
    "reject" )
  return
    admin:database-add-geospatial-path-index($config, $dbid, $indexspec)

  (: returns the new configuration element -- use admin:save-configuration
     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