XQuery admin:appserver-add-module-location

MarkLogic 12 EA 1 Product Documentation
admin.appserverAddModuleLocation

admin.appserverAddModuleLocation(
   config as element(configuration),
   appserver-id as (Number|String),
   module-locations as element(gr.moduleLocation)[]
) 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.appserverGetId` 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

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const appserverId =
  admin.appserverGetId(config,
    admin.groupGetId(config, "Default"), "myAppserverName")
admin.appserverAddModuleLocation(config, appserverId,
     admin.groupModuleLocation("myNamespace", "/my/location/module.xqy"))

   //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 12 EA 1 Product Documentationadmin.appserverAddModuleLocation

Summary

Required Privileges

Example

MarkLogic 12 EA 1 Product Documentation
admin.appserverAddModuleLocation