JavaScript admin.appserverAddModuleLocation

MarkLogic 9 Product Documentation
admin:appserver-add-module-location

admin:appserver-add-module-location(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $module-locations as element(gr:module-location)*
) as element(configuration)

Summary

Add one or more module namespace to location mappings to an App Server configuration. The mappings are used to look up a location for an XQuery library module for any request on that App Server when the library module is requested using only the module namespace URI.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
appserver-id	The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
module-locations	A sequence of module location mapping element. Typically these are the result of calls to admin:group-module-location().

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{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 $appserver-id :=
  admin:appserver-get-id($config,
    admin:group-get-id($config, "Default"), "my-appserver-name")
return
admin:appserver-add-module-location($config, $appserver-id,
     admin:group-module-location("my-namespace", "/my/location/module.xqy"))

  (: 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.  :)

MarkLogic 9 Product Documentationadmin:appserver-add-module-location

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin:appserver-add-module-location